Skip to content

Introspect the calling API key (workspace, tenant, scopes)

GET
/api/public/v1/_introspect
Code sample: cURL
curl --request GET \
--url 'https://api.getzutax.com/api/public/v1/_introspect' \
--header 'Authorization: Bearer <token>'

Returns the workspace_id, tenant_id, api_key_id, and granted scopes resolved from the bearer API key. Useful for ERP integrations to verify their key is configured correctly before issuing real calls.

Successful Response

Media type application/json
Response Introspect Api Public V1 Introspect Get
object
key
additional properties
any
Examples
Example Authenticated API key

Resolved workspace, tenant, and scopes

{
"workspace_id": "6c4e2b55-6ed1-44ec-b7c5-4f7a2b701c62",
"tenant_id": "f95d2e39-329d-4bb3-88e2-6622f0f6cb8a",
"api_key_id": "2a69d8df-16b0-45f6-b03f-7f0c6f4be02a",
"scopes": [
"parties:read",
"parties:write",
"products:read",
"products:write",
"invoices:write",
"invoices:transmit"
]
}