Endpoint
Required Scope
Your API key must have theaccounts:read scope (or the broader all:read scope) to call this endpoint.
Path Parameters
string
required
The unique identifier of the account to retrieve. Accepts either:
- A Knock2 account ID (e.g.
acc_01HX...), or - A company domain (e.g.
acme.com) for a domain-based lookup.
Request Parameters
string
Read a direct child tenant’s account instead of your own (multi-tenant partners only). The
X-Knock-Tenant header takes precedence if both are supplied. See Reading a Child Tenant’s Data.string
Same as
product_slug above, as a header instead of a query param. Naming a slug that isn’t a direct child of your key returns 404, never 403.Example Requests
Response
Returns200 OK with a data object containing the full account record.
Example response
Response Fields
object
required
The full account record.
Error Responses
401 Unauthorized
404 Not Found
422 Validation Error
429 Rate limit exceeded