Skip to main content
GET
Get an organization

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Path Parameters

organization_id
string<uuid>
required

Unique organization ID or my.

Response

OK: Returns the organization.

Organization groups accounts into a single unit. Each organization must contain at least one account and one owner. An account can be assigned to many organizations at once. The default organization is the first assigned to a given account.

organization_id
string<uuid>
default:my
read-only

Unique organization identifier.

name
string

The organization name.

Maximum string length: 127
invitation_mode
enum<string>
default:lax

Controls invitation permissions for the organization. Determines whether all paid roles or only privileged roles can send product invitations.

Available options:
lax,
strict
domain_whitelist
boolean
default:false

If true: email address domain whitelisting is enabled.

products
object[]
read-only

Installed products in the organization.

updated_at
string<date-time>
read-only

Date of the most recent modification to the resource.

created_at
string<date-time>
read-only

Creation date of the resource.

company
object

Basic company information.