Get an organization | API reference

Description

Returns an organization's group bindings, roster and open-seat counts, stored billing and purge progress, Stripe binding, and its latest 50 billing events. Only root operators may call it, and each request is recorded in the root audit trail.

Authentication

Requires a signed-in session: the client sends its session token as a bearer token in the Authorization header.

Parameters

Name	In	Type	Details
`organizationId`	path	string	required lowercase UUID v4

Responses

200 OK

application/jsonRootOrganizationDetailResponse

One organization's group bindings, roster counts, stored billing, Stripe binding, and recent billing events.

5 fields

organizationRootOrganizationSummaryResponserequired
overviewobjectrequired
6 fields
- adminGroupIdstringrequired
  - not empty
- memberGroupIdstringrequired
  - not empty
- activeMemberCountintegerrequired
  - at least 0
- disabledMemberCountintegerrequired
  - at least 0
- syncPausedMemberCountintegerrequired
  - at least 0
- openSeatAssignmentCountintegerrequired
  - at least 0
Other fields are allowed.
billingobjectrequirednullable
17 fields
- currentPeriodEndsAtstringrequirednullable
- disabledAtstringrequirednullable
- providerstringrequirednullable
- purgeAfterstringrequirednullable
- purgedAtstringrequirednullable
- seatCountintegerrequired
  - at least 0
- statusstringrequired
  - one of local, trialing, active, disabled, deleting, purged
- trialEndsAtstringrequirednullable
- currentPeriodStartsAtstringrequirednullable
- providerCustomerIdstringrequirednullable
- providerSubscriptionIdstringrequirednullable
- providerProductIdstringrequirednullable
- providerTransactionIdstringrequirednullable
- entitlementIdstringrequirednullable
- purgeStartedAtstringrequirednullable
- createdAtstringrequired
- updatedAtstringrequired
Other fields are allowed.
stripeobjectrequirednullable
13 fields
- customerIdstringrequirednullable
- subscriptionIdstringrequirednullable
- subscriptionItemIdstringrequirednullable
- priceIdstringrequirednullable
- lastInvoiceIdstringrequirednullable
- desiredPaidCapacityintegerrequired
  - at least 0
- desiredRenewalQuantityintegerrequired
  - at least 0
- appliedPaidCapacityintegerrequired
  - at least 0
- observedQuantityintegerrequirednullable
  - at least 0
- lastSyncedAtstringrequirednullable
- nextAttemptAtstringrequirednullable
- attemptCountintegerrequired
  - at least 0
- lastErrorstringrequirednullable
Other fields are allowed.
historylist of OrganizationBillingHistoryEntryrequired
The 50 most recent billing events.

Other fields are allowed.

Other responses

Status	Meaning	Body
400	Bad Request	`application/json`ErrorResponse
401	Unauthorized	`application/json`SessionFailureResponse
403	Forbidden	`application/json`ErrorResponse
404	Not Found	`application/json`ErrorResponse
500	Internal Server Error	`application/json`ErrorResponse
503	Service Unavailable	`application/json`ErrorResponse