v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB

Organizations

List Organizations

Returns a list of all organizations the user has access to.

In order to access this endpoint, the provided API key must have at least one of the following roles:

Organization Owner
Project Creator
Organization Member

To learn more, see Organization Roles.

get/v4/organizations

Response

Successfully listed all the organizations.

Example response

{
  "data": [
    {
      "id": "ffffffff-aaaa-1414-eeee-000000000000",
      "name": "My-Organization",
      "subdomain": "abc",
      "description": "The description of the organization.",
      "preferences": {
        "sessionDuration": 3600
      },
      "audit": {
        "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "createdAt": "2021-09-01T12:34:56Z",
        "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "modifiedAt": "2021-09-01T12:34:56Z",
        "version": 1
      }
    }
  ]
}