Skip to content
ApiKeyObject

A per-business API key for the partner Business API. A request presenting Authorization: Bearer <key> resolves to this key's business and scopes. The secret itself is shown once at creation and stored only as a hash; this type exposes the non-secret keyPrefix for identification.

Fields

idID!
businessBusiness!

Canonical staff-admin page for this API key. Consume instead of building paths from the id.

nameString!

Owner-facing label, e.g. Zapier or BrandBot sync.

keyPrefixString!

Non-secret leading fragment of the key (e.g. sk_live_8f3a…), shown so the key can be identified in lists without revealing the secret.

scopes[String!]!

Permission scopes granted to this key (e.g. participants:read). Effective access is the intersection of these and the business's own grants.

lastUsedAtDateTime

When the key was last used to authenticate a request, or null if never.

expiresAtDateTime

When the key expires, or null for no expiry.

createdAtDateTime!

Used in

ApiKey