/api/v1 base path, returns a consistent response envelope, and is authenticated. The full, generated endpoint reference is in the sidebar — this page covers the conventions that apply across all of it.
Base URL
Authentication
Most endpoints require a bearer token. Server-to-server integrations use OAuth 2.0 Client Credentials; first-party browser clients use the/auth/v2 cookie session, including SSO and magic-link sign-in.
Response envelope
Successful responses wrap their payload in a consistent envelope:success: false and a structured error. See Error handling for status codes and error codes, and Rate limits for limit headers and the 429 contract.
Where to start
Authentication
OAuth 2.0, cookie sessions, SSO, and magic-link sign-in
Adoption state
Read a tenant’s maturity, milestones, and next-best-action
Company enrichment
Stream profile-enrichment suggestions over SSE
Rate limits
Limits, usage, and contextual upgrade prompts