Skip to main content

GET /api/v1/organizations//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.

Request

Path Parameters

organization_id
string
required
Unique identifier of the organization. Must start with ‘org_’ and be 1-32 characters long.
org_123

Query Parameters

page_size
integer
Maximum number of users to return in a single response. Valid range: 1-100.
50
page_token
string
Pagination token from a previous response. Leave empty for the first request.
eyJwYWdlIjogMiwgImxhc3RfaWQiOiAidXNyXzEyMzQ1In0=

Response

users
array
List of user objects for the current page.
next_page_token
string
Opaque token for retrieving the next page of results. Empty if there are no more pages.
eyJwYWdlIjogMiwgImxhc3RfaWQiOiAidXNyXzEyMzQ1In0=
prev_page_token
string
Opaque token for retrieving the previous page of results. Empty for the first page.
eyJwYWdlIjogMCwgImZpcnN0X2lkIjogInVzcl85ODc2NSJ9
total_size
integer
Total number of users matching the request criteria, regardless of pagination.
1042

Examples

    List All Users in Environment

    GET /api/v1/users

    Retrieves a paginated list of all users across your entire environment, regardless of organization membership.

      Error Responses

      200
      success
      Successfully retrieved the list of users in the organization

      Build docs developers (and LLMs) love