사용자 목록 조회

사용자 목록 조회

get

에이전트 소속 사용자 목록을 조회합니다. 페이징, 정렬, 검색 기능을 지원합니다.

쿼리 스트링이 없으면 기본으로 최근 생성 사용자 200명을 반환합니다.

updated_at, desc 정렬로 실시간 유저 동향을 파악할 수 있습니다.

---

주요 기능:

• 페이징 처리 (기본 20개씩)

• 사용자명 검색 (부분 일치)

• 다양한 정렬 옵션

• 총 사용자 수 및 페이지 정보 제공

정렬 옵션:

• username: 사용자명 순

• created_at: 생성일 순 (기본값)

• balance: 잔액 순

• updated_at: 수정일 순

• 각 필드별 오름차순(asc) / 내림차순(desc) 지원

권한 요구사항:

• API Key 헤더 필수

• Agent ID 헤더 필수

• 본인 에이전트 소속 사용자만 조회 가능

Authorizations

ApiKeyAuthAgentIdAuth

api-keystringRequired

에이전트별 발급된 API 키를 입력하세요

Query parameters

sortBystring · enumOptional

정렬 기준 필드

Possible values:

searchStringstring · min: 1 · max: 50Optional

사용자명 검색어 (부분 일치, 대소문자 구분 안함)

Example: john

sortDirectionstring · enumOptional

정렬 순서

Possible values:

sizenumberOptional

페이지당 항목 수 (최대 100개)

Example: 20

pagenumberOptional

페이지 번호 (1부터 시작)

Example: 1

Responses

200

사용자 목록 조회 성공

application/json

400

잘못된 쿼리 파라미터

application/json

401

인증 실패

application/json

500

서버 내부 오류

application/json

get

/api/users/list

HTTPcURLJavaScriptPython

GET /api/users/list HTTP/1.1
Host: {HIGHEND-API-SERVER}
api-key: YOUR_API_KEY
Accept: */*

{
  "users": [
    {
      "id": 12345,
      "username": "john_doe",
      "provider_user_id": "PU_1234567890123456",
      "balance": 150000.75,
      "agent_id": 1,
      "idcode": "AGENT001",
      "is_kicked": false,
      "created_at": "2025-01-15T09:30:00.000Z",
      "updated_at": "2025-01-20T14:25:30.000Z"
    }
  ],
  "pagination": {
    "total": 125,
    "page": 1,
    "size": 20,
    "totalPages": 7,
    "hasNext": true,
    "hasPrev": false
  }
}