latestOpenAPI 3.0.12026-08-10234260964.0 KB

6cc88fde6435

Organizations

Get organization

Retrieves the specified organization.

get/organizations/{organization_id}

Path parameters

organization_idstring required

The ID of the organization.<br> Prefix with name= to retrieve the organization by name instead.

Response

OK

idstring ulid

The ID of the organization.

type'fixed' | 'flexible'

The type of the organization.

owner_idstring uuid

The ID of the owner.

namespacestring

The namespace in which the organization name is unique.

namestring

A unique machine name representing the organization.

labelstring

The human-readable label of the organization.

countrystring

The organization country (2-letter country code).

capabilitiesstring[]

The organization capabilities.

vendorstring

The vendor.

billing_account_idstring

The Billing Account ID.

billing_legacyboolean

Whether the account is billed with the legacy system.

security_contactstring email

The security contact email address for the organization.

status'active' | 'restricted' | 'suspended' | 'deleted'

The status of the organization.

created_atstring date-time

The date and time when the organization was created.

updated_atstring date-time

The date and time when the organization was last updated.