Get Numeral Access Token
GET/api/numeral/instances/:instance/access-token
The read-only access token this account has given Numeral, masked. issued is false when there is none.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Response data: issued, token_id, masked_token (token id and the last four characters), abilities (always orders:read, customers:read, settings:read — read access to sales orders, sales credits, customers and sales channels), allowed_ips (CIDR allow-list; empty = any address), rate_limit_per_minute (600), created_at, expires_at (one year after issue or rotation), expires_in_days, is_expired, last_used_at, last_used_ip, issued_by / consented_by ({id, name}), consented_at, consent_text (the consent the user accepted, or the text to show before issuing) and plain_text_token (the usable token — only in the issue and rotate responses, null everywhere else).
Authentication: Requires a Bearer token. Requires the integrations.show permission.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.