List Clients

Get a paginated list of clients associated with a project.

Endpoint

/api/v1/projects/{project_id}/clients

Method

GET

Path Parameters

Parameter	Type	Required	Description
`project_id`	`string`	Yes	Unique ID of the project

Headers

Header	Required	Description
`Authorization`	Yes	Bearer access token: `Bearer <access_token>`

Query Parameters

Parameter	Type	Required	Description
`page_num`	`integer`	No	Page number (default: 1)
`page_size`	`integer`	No	Results per page (default: 10)
`sort_by`	`string`	No	Field name to sort by. Option: `created_at` (default) `name` `code`
`sort_dir`	`string`	No	Sort direction. Option: `asc` `desc` (default)
`search`	`string`	No	Search keyword for client name
`is_active`	`boolean`	No	Filter by active status

Required Permission

clients:read

Examples

curl --request GET \
  --url https://auth.roled.id/api/v1/projects/2JUSLUee46xG6iEwG8JwPc/clients \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJo...'

{
  "success": true,
  "data": [
    {
      "id": "2JRYkzSeBV89itqcU9mraF",
      "created_at": "2026-07-16T14:30:00Z",
      "updated_at": "2026-07-29T08:30:00Z",
      "name": "Main Client",
      "description": "Main client for Business App",
      "is_default": true,
      "is_active": true
    },
    {
      "id": "2JUV7yC7gWEuzu8BTEXoY5",
      "created_at": "2026-07-26T01:42:20Z",
      "updated_at": "2026-07-29T08:30:00Z",
      "name": "Backend Service",
      "description": "Server-side service for automated user and role management",
      "is_default": false,
      "is_active": true
    }
  ],
  "pagination": {
    "page_num": 1,
    "page_size": 2,
    "total_data": 2
  }
}

Error Codes

Code	HTTP Status	Description
`invalid_authorization_token`	401	Missing or invalid authorization token
`insufficient_permission`	403	Insufficient permission
`project_not_found`	404	Project not found
`system_error`	500	Internal server error

Clients Get Client Details