Users
List all users in environment
Retrieves a paginated list of all users across your entire environment. Use this endpoint to view all users regardless of their organization memberships. This is useful for administrative purposes, user audits, or when you need to see all users in your Scalekit environment. Supports pagination for large user bases.
get/api/v1/users
Query parameters
page_sizeinteger
Maximum number of organizations to return per page. Must be between 10 and 100
page_tokenstring
Pagination token from the previous response. Use to retrieve the next page of organizations
Response
List of users.
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"
}
}
]
}