Skip to main content
Upcoming. Partner API credentials are not available yet. This page documents the requirements for partner API access. For assistant sign-in, see MCP authentication.

Purpose

The authentication and scope model the API must have before the intelligence surface publishes for external integrations.

What is required before this publishes

  1. API-key or OAuth client-credentials auth.
  2. Scopes, at minimum:
    • read
    • write
    • destructive
    • billing/comms-impacting, for operations that spend money or message candidates (phone calls, AI interviews, invite sends)
  3. Per-key rate limits and quotas across every published endpoint.
  4. Per-organization data-access controls enforced at the API gateway for every published operation.
  5. GraphQL versioning and a deprecation policy.
  6. DPA and legal sign-off for any operation returning candidate PII (reports, transcripts, recordings).

Scope-gated operations

Operations that spend money, message candidates, change decisions or delete data each require their own scope. The full scope map is published with the API when it goes live.
The Career Page capability is exempt. It is public and unauthenticated by design.

Tracking

Progress against this checklist is tracked internally. This checklist applies to the partner API.

FAQs

Not as a partner API client. API-key or OAuth client-credentials auth is Upcoming. For assistant access, see Connected Agent Access.
At minimum read, write, destructive, and billing/comms-impacting, plus decisions:write for decision overrides.
Because they spend money, message candidates, or change the hiring audit trail. Those are never in the default read tier.
Yes, the Career Page. Partner API operations require partner credentials.