List Tax Exemption Certificates
GET/api/tax-exemption-certificates
The register of tax exemption certificates across every customer, filtered, sorted and paginated. Each row includes its customer (id, name).
customers:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Filters can also be sent as a filter_groups tree (AND/OR groups of conditions over the same columns), base64-encoded JSON in the query string.
Every certificate carries a computed status (with status_label):
valid— approved and in dateexpiring— approved, andexpires_onis within the next 60 daysexpired— approved, andexpires_onhas passedlapsed— approved withexpiry_rule: lapse_after_inactivity, and 12 months have passed since the customer's last order (lapses_onis the date it lapses)pending— waiting for reviewrejected,revoked— closed by a reviewersuperseded— replaced by an approved renewal (superseded_by_id/superseded_by_number)
review_status is the stored review state (pending, approved, rejected, revoked). days_remaining counts days to expires_on (negative once expired; null without an expiry date). covers_any_state is true for a certificate with no states recorded — such a certificate covers every state until its states are set. document.download_url downloads the attached file. Dates are Y-m-d in the account's timezone; timestamps are ISO-8601 UTC.
Authentication: Requires Bearer token with the customers:read scope. Permission: customers.show.
Request
Responses
- 200
- 401
- 403
- 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.
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.