Skip to main content
Sub-accounts let you separate API activity within a workspace. Each sub-account has its own identifier. Attach it to a request to keep the enrichments of the sub-account separate from direct workspace activity. All sub-accounts use the credit balance of the workspace. A sub-account has no balance of its own.
Sub-accounts are in beta.

​
Manage sub-accounts

Use the sub-account endpoints to create, list, retrieve, rename, archive, or restore sub-accounts. Management requests always run at the workspace level. Authenticate with the workspace API key and do not send the Sub-Account-ID header when calling /sub-accounts endpoints.

Create a sub-account

Create a new isolated API scope.

List sub-accounts

List active sub-accounts or include archived ones.

Get a sub-account

Retrieve one sub-account by ID.

Update a sub-account

Rename, archive, or restore a sub-account.

​
Make requests for a sub-account

Authenticate with the workspace API key and add the Sub-Account-ID header:
These endpoints run in the scope of the sub-account: Read a result with the same scope you used to create it. An enrichment created for a sub-account returns 404 without its Sub-Account-ID. An enrichment created without the header returns 404 with it. The other endpoints, such as search and GET /account/credits, run at the workspace level. They still check the header when you send it. Calls made without Sub-Account-ID remain direct workspace calls. An archived sub-account accepts GET requests and rejects all other requests.
Do not send Sub-Account-ID when creating, listing, retrieving, or updating sub-accounts. These management endpoints require the direct workspace scope.

​
Errors

​
Webhooks for a sub-account

When an enrichment runs for a sub-account, every webhook call for this enrichment includes the Sub-Account-ID header with the sub-account ID. Use it to route the results to the correct sub-account. Webhook calls for direct workspace enrichments do not include this header.