v4

latestOpenAPI 3.1.1Apache 2.02026-07-31107278570.4 KB

Organizations

List organizations

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

get/api/v1/organizations

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

external_idstring

Your application's unique identifier for this organization, used to link Scalekit with your system

Response

Successfully retrieved the list of organizations

next_page_tokenstring

Pagination token for the next page of results. Use this token to fetch the next page.

prev_page_tokenstring

Pagination token for the previous page of results. Use this token to fetch the previous page.

total_sizeinteger

Total number of organizations in the environment.

Example response

{
  "next_page_token": "<next_page_token>",
  "organizations": [
    {
      "create_time": "2025-02-15T06:23:44.560000Z",
      "display_name": "Megasoft",
      "external_id": "my_unique_id",
      "id": "org_59615193906282635",
      "logo_url": "https://cdn.example.com/acme-logo.png",
      "settings": {
        "features": [
          {
            "enabled": true,
            "name": "sso"
          },
          {
            "enabled": false,
            "name": "directory_sync"
          }
        ]
      },
      "slug": "acme",
      "update_time": "2025-02-15T06:23:44.560000Z"
    }
  ],
  "prev_page_token": "<prev_page_token>",
  "total_size": 30
}