List exemptions
List exemptions, keyset-paginated. Covers every organization your credential owns; send an Organization-Id, Connection-Id or Entity-Id selector to narrow to one. Filter to one customer's exemptions with customerId, and to a country, jurisdiction, validity start or end date, connection, or a customer name / email substring with the matching parameter. Pass sort and order to order the list; omit sort to keep the default order. sort=customerName orders by the owning customer's name. Pass expand=customer to embed the owning customer's companyName and customerName under customer on each row. Pass limit and the opaque cursor from a prior response's nextCursor or previousCursor to page; hasMore and hasPrevious report whether a page exists that way. Archived exemptions are excluded. A cursor is only valid for the sort, the filters AND the organization scope it was issued under, including any selector header: change any of them and start again from the first page. expand does not affect which exemptions are returned, so a cursor stays valid whether or not you pass it.
Authorization
Headers
Release date, as YYYY-MM-DD. Defaults to 2026-07-21.
Narrow the request to one organization (Organization-Id selector).
Narrow the request to a connection's organization.
Narrow the request to a platform entity's organization.
Optional source to disambiguate an Entity-Id.
Query
Every query parameter below is optional. Combine as many as you need and append them to the endpoint as a query string. The example shows a few to get you started.
/exemptions?sort=<sort>&order=<order>&customerId=<customerId>Field to sort by. Omit to keep the default ordering. customerName orders by the owning customer's name, resolved server-side.
countryjurisdictioncustomerNamestartDateendDatestatusSort direction. Applies only when sort is set. Defaults to asc.
ascdescComma-separated customer ids; matches any of them. This is how you read one customer's exemptions.
Comma-separated transaction ids; matches any of them.
Comma-separated lifecycle statuses; matches any of them. ARCHIVED is never returned and is rejected here.
Comma-separated exemption types; matches any of them.
Comma-separated ISO 3166-1 alpha-2 country codes; matches any of them.
State or province code the exemption is scoped to.
Match exemptions whose validity start date is this date.
Match exemptions whose validity end date is this date.
Match an exact exemption id, or a customer name or email substring.
Comma-separated connection ids; matches exemptions whose customer belongs to any of them.
Relations to embed on each exemption. Pass customer to embed the owning customer's companyName and customerName under customer; omitted otherwise. Does not change which exemptions are returned.
customerMaximum number of items to return.
Opaque cursor from a prior response's nextCursor or previousCursor. Omit for the first page.
Response
The exemptions on this page.
Opaque cursor for the next page. null when this is the last page. Send it back as cursor; do not parse it.
Opaque cursor for the previous page. null when this is the first page. Send it back as cursor; do not parse it.
Whether a page exists after this one.
Whether a page exists before this one.
Successful Response
The request was invalid.
Authentication failed or was missing.
The credential is not permitted for this request.
The requested resource was not found.
The request conflicts with existing state.
The request failed validation.