📚
Full PageDocumentation Pages
API Reference
API 문서 페이지 - 엔드포인트, 파라미터, 코드 예제
문서API엔드포인트 트리HTTP 메서드 배지파라미터 테이블요청/응답 예시상태 코드코드 블록
데모 로딩 중...
API 문서 페이지 - 엔드포인트, 파라미터, 코드 예제
데모 로딩 중...
/api/v1/usersRetrieves a paginated list of all users in the system. Supports filtering by role, status, and creation date. Results are sorted by creation date in descending order by default.
| Name | Type | Required | Description |
|---|---|---|---|
page | integer | Optional | Page number for pagination (default: 1) |
limit | integer | Optional | Number of results per page (default: 20, max: 100) |
role | string | Optional | Filter by user role: admin, editor, viewer |
status | string | Optional | Filter by status: active, inactive, suspended |
sort | string | Optional | Sort field: created_at, name, email |
curl -X GET "https://api.example.com/api/v1/users?page=1&limit=10" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json"
{
"data": [
{
"id": "usr_1a2b3c",
"name": "Alice Johnson",
"email": "alice@example.com",
"role": "admin",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
},
{
"id": "usr_4d5e6f",
"name": "Bob Smith",
"email": "bob@example.com",
"role": "editor",
"status": "active",
"created_at": "2024-01-14T08:00:00Z"
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 142,
"pages": 15
}
}| Code | Description |
|---|---|
| 200 | OK - Request succeeded |
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Invalid or missing API key |
| 404 | Not Found - Resource does not exist |
| 500 | Internal Server Error |