Preview a token

Returns a short summary of a token you shared: its state, both company names, the contract and agreement it was shared under, and what was shared.

Only the Donor and the Recipient of a token can read it. Any other company gets 404, the same as for a token that does not exist.

Requires your API key, or a Dashboard user with the case_management:view permission. Limited to 120 requests per minute.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the token, from a webhook, the token list or the export response.

Responses

401

Missing or invalid API key.

429

Rate limit exceeded.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json