Organizations

List affiliated organizations

List the organizations affiliated with the calling key's organization, by public id. Requires the read:orgs scope; orgs:manage also satisfies it. Returns the platform cap and the current count alongside. Lifecycle: a child requests affiliation (dashboard) and becomes PENDING; approve moves PENDING to APPROVED; credits move only while the affiliate is APPROVED and not suspended; offboard reclaims the remaining credits and suspends the affiliate, in any status; revoke ends the relationship from APPROVED or PENDING. offboard then revoke and revoke then offboard are both supported - offboard never requires APPROVED and revoke never refuses a suspended affiliate. Counts against the API key monthly usage quota (no exemption exists for administration routes) and requires the organization payment state to be current.

get/organizations/sub-orgs

Request

  • Base URL: https://app.arkova.ai/api/v1
  • URL: https://app.arkova.ai/api/v1/organizations/sub-orgs
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Response

Affiliated organizations

max_sub_orgsinteger nullable

Platform cap on affiliates for this organization; null means the default applies.

countinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.