Skip to content
Docs

Organizations

Create Organization
POST/v1/organizations
Get Organization Details
GET/v1/organizations/{organization_id}
Update Organization
PATCH/v1/organizations/{organization_id}
List Organizations
GET/v1/organizations
Leave Organization
POST/v1/organizations/{organization_id}/leave
ModelsExpand Collapse
Organization object { id, billing_email, created_at, 9 more }

Organization response.

id: string

Organization ID.

billing_email: string

Billing email. Null when no custom billing email is set (reverts to the oldest owner’s email).

created_at: string

When the Organization was created.

formatdate-time
domains: array of OrganizationDomain { id, domain, verified }

Domains associated with the organization.

id: string

Domain ID.

domain: string

Domain name.

verified: boolean

Whether the domain has been verified.

metronome_customer_id: string

Metronome customer ID.

name: string

Organization name.

personal: boolean

Whether the organization is a personal Organization.

services: OrganizationServices { cloud, jit_provisioning, scim, 2 more }

Services that the Organization has access to.

cloud: boolean

Whether cloud services are enabled for the organization.

jit_provisioning: boolean

Whether just-in-time provisioning is enabled for the organization.

scim: boolean

Whether SCIM provisioning is enabled for the organization.

siem: boolean

Whether SIEM integration is enabled for the organization.

sso: boolean

Whether single sign-on is enabled for the organization.

stripe_customer_id: string

Stripe customer ID.

Organization type.

One of the following:
"personal"
"company"
updated_at: string

When the Organization was updated.

formatdate-time
auth_id: optional string

Authentication provider organization ID.

OrganizationDomain object { id, domain, verified }

Organization domain details.

id: string

Domain ID.

domain: string

Domain name.

verified: boolean

Whether the domain has been verified.

OrganizationList object { items, pagination }
items: array of Organization { id, billing_email, created_at, 9 more }
id: string

Organization ID.

billing_email: string

Billing email. Null when no custom billing email is set (reverts to the oldest owner’s email).

created_at: string

When the Organization was created.

formatdate-time
domains: array of OrganizationDomain { id, domain, verified }

Domains associated with the organization.

id: string

Domain ID.

domain: string

Domain name.

verified: boolean

Whether the domain has been verified.

metronome_customer_id: string

Metronome customer ID.

name: string

Organization name.

personal: boolean

Whether the organization is a personal Organization.

services: OrganizationServices { cloud, jit_provisioning, scim, 2 more }

Services that the Organization has access to.

cloud: boolean

Whether cloud services are enabled for the organization.

jit_provisioning: boolean

Whether just-in-time provisioning is enabled for the organization.

scim: boolean

Whether SCIM provisioning is enabled for the organization.

siem: boolean

Whether SIEM integration is enabled for the organization.

sso: boolean

Whether single sign-on is enabled for the organization.

stripe_customer_id: string

Stripe customer ID.

Organization type.

One of the following:
"personal"
"company"
updated_at: string

When the Organization was updated.

formatdate-time
auth_id: optional string

Authentication provider organization ID.

OrganizationServices object { cloud, jit_provisioning, scim, 2 more }

Services that the Organization has access to.

cloud: boolean

Whether cloud services are enabled for the organization.

jit_provisioning: boolean

Whether just-in-time provisioning is enabled for the organization.

scim: boolean

Whether SCIM provisioning is enabled for the organization.

siem: boolean

Whether SIEM integration is enabled for the organization.

sso: boolean

Whether single sign-on is enabled for the organization.

OrganizationType = "personal" or "company"

Organization type.

One of the following:
"personal"
"company"

OrganizationsMemberships

Get Organization Membership
GET/v1/organizations/{organization_id}/memberships/{membership_id}
List Organization Memberships
GET/v1/organizations/{organization_id}/memberships
ModelsExpand Collapse
OrganizationMembership object { id, created_at, organization_id, 3 more }

Organization membership details.

id: string

Membership ID.

created_at: string

When the membership was created.

formatdate-time
organization_id: string

Organization ID.

role: "owner" or "member"

Role of the user in the organization.

One of the following:
"owner"
"member"
updated_at: string

When the membership was updated.

formatdate-time
user_id: string

User ID.

OrganizationMembershipList object { items, pagination }
items: array of OrganizationMembership { id, created_at, organization_id, 3 more }
id: string

Membership ID.

created_at: string

When the membership was created.

formatdate-time
organization_id: string

Organization ID.

role: "owner" or "member"

Role of the user in the organization.

One of the following:
"owner"
"member"
updated_at: string

When the membership was updated.

formatdate-time
user_id: string

User ID.

OrganizationsAddress

Create Organization Address
POST/v1/organizations/{organization_id}/address
Get Organization Address
GET/v1/organizations/{organization_id}/address
Update Organization Address
PATCH/v1/organizations/{organization_id}/address
ModelsExpand Collapse
OrganizationAddress object { id, city, country, 9 more }

Organization address details.

id: string

Address ID.

city: string

City or locality.

country: string

Two-letter ISO 3166-1 alpha-2 country code.

created_at: string

When the address was created.

formatdate-time
line1: string

First line of the street address.

line2: string

Second line of the street address. Null when not provided.

organization_id: string

Organization ID the address belongs to.

postal_code: string

Postal or ZIP code.

state: string

State, province, or region. Null when not provided.

tax_id: string

Tax identification number. Null when not provided.

tax_id_type: string

Type of the tax identification number. Null when not provided.

updated_at: string

When the address was updated.

formatdate-time