API version

API reference / Get exemptions

Get exemptions

GET/v1/exemptions

Retrieve a list of exemptions based on filters.

Authorization

x-api-keystringRequired

Your secret API key. Include it with every request.

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.

/v1/exemptions?search_query=<search_query>&country_code=<country_code>&page=<page>

search_querystring

Search term to filter exemptions by exemption ID, customer name, or customer email

status__instring

Filter exemptions by their status

country_codeCountryCodeEnum | string[]

Country code in ISO 3166-1 alpha-2 format

Available options:AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCGCDCKCRHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMKMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZWXKZZ_EU

jurisdictionstring

Jurisdiction identifier

start_datestring

Start date for filtering exemptions

end_datestring

End date for filtering exemptions

customer_idstring

Customer ID to filter exemptions

transaction_idstring

Transaction ID to filter exemptions

connection_id__instring

Filter exemptions by customer connection ID (comma-separated)

Available options:conn_abc123conn_def456

order_bystring

Fields to sort by (comma-separated)

pageinteger

Page number

sizeinteger

Page size

Response

itemsbackend__src__exemptions__schemas__exemption__ExemptionRead[]Required

totalintegerRequired

pageintegerRequired

sizeintegerRequired

pagesintegerRequired

200

Successfully retrieved exemptions

401

The request is missing a valid x-api-key or x-organization-id

422

Validation issues, such as missing required fields or invalid field values.

500

Internal Server Error

cURL

GET /v1/exemptions?search_query=John&country_code=US&page=1

-H "x-api-key: ***"

Example request

https://api.trykintsugi.com/v1/exemptions?search_query=John&country_code=US&page=1

Response

{

"items": [

{

"id": "exem_123abc",

"organization_id": "org_456xyz",

"exemption_type": "wholesale",

"jurisdiction": "CA",

"country_code": "US",

"start_date": "2024-01-01",

"end_date": "2025-01-01",

"customer_id": "cust_123",

"transaction_id": "txn_456",

"reseller": true,

"FEIN": "12-3456789",

"sales_tax_id": "ST-98765",

"status": "ACTIVE"

}

"total": 1,

"page": 1,

"size": 50,

"pages": 1

}