Skip to main content

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.

Required scope: accounting:read

Grant 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​

OK

Response Headers
    Content-Type