Skip to content

GET /api/agent/orgs

Lists the client orgs the calling key can reach and reports whether the key is a PARTNER (advisory, multi-client) or USER key. Not quota-metered — call it on connect to discover the partner's client set, then target a specific client per command via the [orgId] path on the nested routes (e.g. /api/agent/orgs/{orgId}/daily-brief). PARTNER keys: returns the advisory-linked clients (intersected with the key's scope ceiling). USER keys: the orgs the key's creator is a member of.

Auth

  • Required scope: any authenticated key
  • Header: Authorization: Bearer cr_live_<prefix>_<secret>

Responses

200 — Key kind + reachable client orgs (orgs MAY be empty)

Body: OrgsResponse

FieldTypeRequiredNotes
keyKindstring · one of PARTNER USERyesPARTNER for an advisory partner key (multi-client); USER for an ordinary org key.
orgsarray of objectyesClient orgs this key can reach, sorted by name. For PARTNER keys these are the advisory-linked clients (intersected with the key's scope ceiling); for USER keys, the orgs the key's creator is a member of.

401 — Missing / invalid bearer

Body: ErrorResponse

FieldTypeRequiredNotes
errorstringyes

Response headers

Every successful response carries X-CashRunway-Subscription, X-CashRunway-Plan, X-CashRunway-Quota-Remaining, and X-CashRunway-Quota-Reset. Trialing subscriptions also include X-CashRunway-Trial-Days-Remaining. See the overview for details.

Released under a proprietary license.