GET/org/data

Get organization details

Returns organization details for the authenticated user's organization. Use the response to check the organization ID, primary email, subscription plan, billing cycle, and account status.

3 status codes
200Returns the organization ID, primary email, account status, creation time, subscription plan and billing cycle, plan data, and Stripe account location.
created_atnumberrequired

Org creation time. Epoch timestamp in milliseconds.

got_free_trialbooleanoptional
idstringrequired

Organization ID

metadataobjectoptional
org_emailstringrequired

Primary email of the organization

planstringrequired

Subscription plan name

plan_cyclestringrequired

Billing cycle. monthly or yearly.

Allowed:monthlyyearly
plan_dataobjectrequired
sso_enabledbooleanoptional

Flag if SSO is enabled for org.

stripe_account_locstringrequired
Allowed:indsgp
unpaidbooleanrequired

Flag if account is blocked due to unpaid dues. False means account is not blocked.

401Returned when the API key or bearer token is missing or invalid.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account has unpaid dues or the authenticated user lacks the required role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired

Error handling

A 401 is returned when the API key or bearer token is missing or invalid. A 403 is returned when the account has unpaid dues or the authenticated user lacks the required role permissions.