KintsugiKintsugi
API reference / Get registrations

Get registrations

GET/v1/registrations

The Get Registrations API retrieves a paginated list of registrations. This API helps in tracking and managing registrations efficiently across multiple jurisdictions.

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/registrations?status__in=<status__in>&country_code__in=<country_code__in>&page=<page>
status__instring

Filter registrations by status. Multiple statuses can be passed, separated by commas.

Available options:REGISTEREDPROCESSINGUNREGISTEREDDEREGISTERINGDEREGISTEREDCANCELLEDVALIDATINGAWAITING_CLARIFICATIONSELF_MANAGED
state_codestring

Filter registrations by state code.

filing_frequency__instring

Filter registrations by filing frequency. Multiple filing frequencies can be passed, separated by commas.

country_code__inCountryCodeEnum | string[]

Filter registrations by country code in ISO 3166-1 alpha-2 format (e.g., US, CA).

Available options:AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCGCDCKCRHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMKMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZWXKZZ_EU
tax_type__instring

Filter registrations by tax type. Multiple tax types can be passed, separated by commas (SALES_TAX, USE_TAX, SALES_AND_USE_TAX).

order_bystring

Order results by specified fields (comma-separated)

pageinteger

Page number

sizeinteger

Page size

Response

itemsRegistrationReadWithPassword[]Required
totalintegerRequired
pageintegerRequired
sizeintegerRequired
pagesintegerRequired
200

Successfully retrieved registrations

401

Unauthenticated request.

404

Resource not found

422

Validation error

500

Internal server error

cURL
GET /v1/registrations?status__in=REGISTERED,PROCESSING,UNREGISTERED,DEREGISTERING,DEREGISTERED,CANCELLED,VALIDATING,AWAITING_CLARIFICATION,SELF_MANAGED&country_code__in={country_code__in}&page=1
-H "x-api-key: ***"
Example request
https://api.trykintsugi.com/v1/registrations?status__in=REGISTERED,PROCESSING,UNREGISTERED,DEREGISTERING,DEREGISTERED,CANCELLED,VALIDATING,AWAITING_CLARIFICATION,SELF_MANAGED&country_code__in={country_code__in}&page=1
Response
{
"items": [
{
"registration_date": "2024-01-01",
"registration_email": "example@company.com",
"status": "REGISTERED",
"registration_requested": "2023-12-20T10:45:00.000Z",
"registration_completed": "2023-12-25T12:00:00.000Z",
"auto_registered": true,
"country_code": "US",
"state_code": "CA",
"state_name": "California",
"filing_frequency": "MONTHLY",
"username": "admin@company.com",
"comment": "First-time registration for California.",
"create_filings_from": "2024-01-01",
"initial_sync": true,
"amount_fees": "0.00",
"vda": false,
"imported": true,
"sales_tax_id": "ST-12345",
"id": "regs_XYZ123",
"password_encrypted": "gAAAAABlC9np...randomstring",
"has_all_credentials": true
},
{
"registration_email": "support@company.com",
"status": "PROCESSING",
"registration_requested": "2024-01-10T08:30:00.000Z",
"auto_registered": false,
"country_code": "US",
"state_code": "NY",
"state_name": "New York",
"filing_frequency": "QUARTERLY",
"comment": "Pending clarification from the state.",
"initial_sync": false,
"amount_fees": "10.00",
"vda": true,
"imported": false,
"id": "regs_ABC789",
"has_all_credentials": false
}
],
"total": 2,
"page": 1,
"size": 50,
"pages": 1
}