사용자 목록
사용자 목록을 페이징 조회 할 수 있습니다.
조회 정렬 기준은 생성일 내림차순입니다.
다음 페이지가 있을 경우 응답 데이터에 'next' 정보가 전달됩니다. 응답에서 받은 'next' 값을 사용하여 다음 목록을 조회 할 수 있습니다. 다음 페이지 조회 시, 'next' 값만 전달하면 됩니다.
GET /v1/users
Parameters
| 속성 | 설명 | 유형 | 기본값 | 필수여부 |
|---|---|---|---|---|
| limit | 페이지 당 목록 수, 허용 범위 5 ~ 30 | Number | 15 | X |
| name | 검색할 사용자 이름(URL 인코딩 권장) | String | 없음 | X |
| next | 다음 페이지 키 | String | 없음 | X |
Request
GET /v1/users?name=홍길동
GET /v1/users?next={Next Key}
Response
200 success
// 생성, 갱신 시 필수가 아니거나 기본값이 없는 필드는 값이 없을 경우 응답에서 누락 될 수 있습니다.
{
"users": [
{
"user_id": "User ID",
"name": "User Name",
"profile_url": "User Profile URL",
"meta": {
"key": "value",
...
},
"created_at": 1658977173917,
"updated_at": 1658977173917
},
...
],
"next": "Next Key", // 다음 페이지 키
}
사용자 정보
특정 사용자를 조회 할 수 있습니다.
GET /v1/users/{user_id}
Parameters
| 속성 | 설명 | 유형 | 필수여부 |
|---|---|---|---|
| user_id | 사용자 아이디 | String | O |
Request
GET /v1/users/user_1
Response
200 success
// 생성, 갱신 시 필수가 아니거나 기본값이 없는 필드는 값이 없을 경우 응답에서 누락 될 수 있습니다.
{
"user_id": "User ID",
"name": "User Name",
"profile_url": "User Profile URL",
"meta": {
"key": "value",
...
},
"created_at": 1658977173917,
"updated_at": 1658977173917
}