Skip to main content
This flow can be executed using a human or a machine user.For machine users:
  • Send a valid Authorization header with of type Bearer TOKEN_VALUE where TOKEN_VALUE is the a JWT returned in the response from Machine User Token flow
To retrieve a list of all organizations accessible to your user, you need to make a GET request to the following endpoint:

​
Query Parameters

1

page (optional, number)

Specifies the page number to retrieve. Use this parameter to paginate through large sets of organizations. Defaults to 0 if not provided. Example: ?page=2
2

pageSize (required, number)

Specifies the number of organizations to return per page. This helps to control the size of the response data. pageSize must not be greater than 100. Example: ?pageSize=10
Upon successful request, you will receive a paginated response similar to the below:
  • metadata.total: The total number of organizations available.
  • organizations: A list of organization objects, each containing:
    • id: The unique identifier of the organization.
    • name: The name of the organization.
    • status: The current status of the organization (e.g., Active, Inactive).
Link to Playground