Skip to main content

GET /api/v1/organizations

Retrieves a paginated list of organizations within your environment. The response includes a next_page_token that can be used to access subsequent pages of results.

Request

Query Parameters

page_size
integer
Maximum number of organizations to return per page. Must be between 10 and 100.
50
page_token
string
Pagination token from the previous response. Use to retrieve the next page of organizations.
eyJwYWdlIjogMiwgImxhc3RfaWQiOiAib3JnXzEyMzQ1In0=
external_id
string
Your application’s unique identifier for this organization, used to link Scalekit with your system.
my_unique_id

Response

organizations
array
List of organization objects.
next_page_token
string
Pagination token for the next page of results. Use this token to fetch the next page.
<next_page_token>
prev_page_token
string
Pagination token for the previous page of results.
<prev_page_token>
total_size
integer
Total number of organizations in the environment.
30

Examples

    Error Responses

    400
    error
    Invalid page token

    Build docs developers (and LLMs) love