Users
List organization users
Retrieves a paginated list of all users who are members of the specified organization. Use this endpoint to view all users with access to a particular organization, including their roles, metadata, and membership details. Supports pagination for large user lists.
get/api/v1/organizations/{organization_id}/users
Path parameters
organization_idstring required
Unique identifier of the organization for which to list users. Must start with 'org_' and be 1-32 characters long.
Query parameters
page_sizeinteger
Maximum number of users to return in a single response. Valid range: 1-100. Server may return fewer users than specified.
page_tokenstring
Pagination token from a previous ListUserResponse. Used to retrieve the next page of results. Leave empty for the first request.
Response
Successfully retrieved the list of users in the organization
Example response
{
"next_page_token": "eyJwYWdlIjogMiwgImxhc3RfaWQiOiAidXNyXzEyMzQ1In0=",
"prev_page_token": "eyJwYWdlIjogMCwgImZpcnN0X2lkIjogInVzcl85ODc2NSJ9",
"total_size": 1042,
"users": [
{
"email": "user@example.com",
"external_id": "ext_12345a67b89c",
"id": "usr_1234abcd5678efgh",
"memberships": [
{
"display_name": "Acme Corporation",
"metadata": {
"department": "engineering",
"location": "nyc-office"
},
"name": "AcmeCorp",
"organization_id": "org_1234abcd5678efgh",
"permissions": [
"read_projects",
"write_tasks",
"manage_users"
],
"roles": [
{
"display_name": "Dev Team",
"id": "role_79643236410327240",
"name": "team_dev"
}
]
}
],
"metadata": {
"department": "engineering",
"location": "nyc-office"
},
"user_profile": {
"custom_attributes": {
"department": "engineering",
"security_clearance": "level2"
},
"email_verified": true,
"external_identities": [
{
"connection_id": "conn_1234abcd5678efgh",
"connection_type": "OAUTH",
"connection_user_id": "ext_user_12345",
"is_social": true
}
],
"family_name": "Doe",
"gender": "male",
"given_name": "John",
"groups": [
"admin",
"developer"
],
"id": "usr_profile_1234abcd5678efgh",
"locale": "en-US",
"metadata": {
"department": "engineering",
"employee_type": "full-time",
"idp_user_id": "12345"
},
"name": "John Michael Doe",
"phone_number": "+14155552671",
"phone_number_verified": true,
"picture": "https://example.com/avatar.jpg",
"preferred_username": "johndoe"
}
}
]
}