Skip to content

List Users

Retrieve a paginated list of users registered within a specific project.

Endpoint

/api/v1/projects/{project_id}/users

Method

GET

Path Parameters

ParameterTypeRequiredDescription
project_idstringYesUnique ID of the project

Headers

HeaderRequiredDescription
AuthorizationYesBearer access token: Bearer <access_token>

Query Parameters

ParameterTypeRequiredDescription
page_numintegerNoPage number (default: 1)
page_sizeintegerNoResults per page (default: 10)
sort_bystringNoField name to sort by. Option:
  • created_at (default)
  • updated_at
  • display_name
  • email
  • is_active
  • external_user_id
  • role_name
sort_dirstringNoSort direction. Option:
  • asc
  • desc (default)
searchstringNoSearch keyword for display name or email
is_activebooleanNoFilter by active status
role_idstringNoFilter by assigned role ID

Required Permission

users:read

Examples

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

Error Codes

CodeHTTP StatusDescription
invalid_authorization_token401Missing or invalid authorization token
insufficient_permission403Insufficient permission
project_not_found404Project not found
system_error500Internal server error