Important: Kintsugi uses API key authentication via headers, not bearer token authentication. You must include both the API key and organization ID in request headers.
Prerequisite
Make sure you have an API key. Refer Creating and managing API Keys.
Make sure you have your organization ID.
- Partner Experience (Partners): The organization/client context and IDs come from within the Partner Experience.
- Kintsugi app (direct customers): You can find your Organization ID in the lower left-hand corner after logging into the Kintsugi Platform.
Making Requests
Now that you have the API Key and Organization ID, you’re ready to make authorized requests to the Kintsugi API.
Authentication Format
Kintsugi API uses header-based API key authentication, not bearer token authentication. Every request requires:x-api-keyheader with your API keyx-organization-idheader with your organization ID
Finding Your Organization ID
Where you find your Organization ID depends on your account type:- Partner Experience (Partners): Your organization/client context and IDs are available within the Partner Experience.
- Kintsugi app (direct customers): Your Organization ID can be found in the lower left-hand corner of the Kintsugi Platform dashboard after you log in. It’s displayed as a unique identifier for your organization.
Client API keys
Client API keys are created with one of two scopes (see Creating and Managing API Keys):- Partner scope: call the Partner APIs (
/v2/partner/*) across your whole portfolio. The portfolio endpoints derive scope from the key; per-organization endpoints still takex-organization-id. - Client scope: call the main organization APIs for a single client. Send
x-organization-idset to that client organization.
x-partner-id header.
