Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
Organizations

Get Organization

Fetches the details of an organization by ID.

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/{organizationId}

Response

Successfully returned the organization details.

idstring uuid required

A GUID4 identifier of the organization.

namestring required

The name of the organization.

subdomainstring

The new name of the subdomain for the organization.

descriptionstring required

The description of a particular organization.

Example response

{
  "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
  }
}