Get an Organization

Retrieve information about a specific Organization.

Path parameters

organizationIdstringRequired

The Organization’s ID.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

isLookUpOnlybooleanOptional

Whether to show only Organization metadata.

Response

OK

createdAtdatetime

The time when the Organization was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

createdByobject
idstring

The Organization’s ID.

isScimEnabledboolean

Whether SCIM is enabled for the Organization.

namestring

The Organization’s name.

supportPlanenum

The Organization’s support plan.

Allowed values:
updatedAtdatetime

The time when the Organization was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

updatedByobject
billingEmailstringOptional

The Organization’s billing email.

managedDomainslist of objectsOptional

The list of managed domains configured in the Organization.

paymentMethodenumOptional

The Organization’s payment method.

Allowed values:
productenumOptional

The Organization’s product type.

Allowed values:
statusenumOptional

The Organization’s status.

Allowed values:
trialExpiresAtdatetimeOptional

The time when the Organization’s trial expires in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ. Organizations that are no longer in Trial will not have a expiry date.

Errors