Organization

Get organizations

Changed on

Returns the list of organizations in the system.

get/v1/organizations

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/organizations
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: organization.read)

Query parameters

page_sizeinteger

Maximum number of items to return.

page_tokenstring

Opaque continuation token from a previous page_info.next_page_token.

Response

OK

Example response

{
  "items": [
    {
      "id": "9bsv0s46s6s002p9ltq0",
      "slug": "acme",
      "name": "ACME Inc.",
      "email": "info@example.com",
      "logo": "https://example.com/static/logo.png",
      "website": "https://example.com",
      "status": "active",
      "member_count": 12,
      "document_count": 4,
      "team_count": 3,
      "namespace_count": 2
    }
  ]
}

Changes

  • 8a34c0b5508eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 836ecb425096Revision changes
    • info

      added the required property // to the response with the status