Partner APIOrganizations

Retrieve an organization

Retrieves a single organization under your partner account.

Authentication

AuthorizationBearer
Partner API key sent as `Authorization: Bearer cfk_...`. Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.

Path parameters

org_idstringRequired

Organization ID (org_...).

Response

The organization.
idstringOptional

Organization ID (org_...).

namestringOptional
statusenumOptional

provisioning while asynchronous setup (e.g. phone number assignment) completes, then active.

locationobjectOptional

City/state/ZIP location.

timezonestringOptional
IANA timezone used for call windows and scheduling.
template_idstringOptional
Screening template the organization was provisioned from.
caller_id_namestringOptional

Caller-ID display name on outbound screening calls.

created_atdatetimeOptional
updated_atdatetimeOptional

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error