TRtrykintsugi
Registrations

Get registrations

Changed on

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

get/v1/registrations

Request

  • Base URL
    https://api.trykintsugi.com
  • URL
    https://api.trykintsugi.com/v1/registrations
  • Auth
    API key in header X-API-KEY

Query parameters

status__instring

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

state_codestring

Filter registrations by state code.

filing_frequency__instring

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

tax_type__instring nullable

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

order_bystring nullable

Order results by specified fields (comma-separated)

pageinteger

Page number

sizeinteger

Page size

Headers

x-organization-idstring nullable required

The unique identifier for the organization making the request

Response

Successfully retrieved registrations

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required

Changes

  • 2c90b14ca671Revision changes
    • warning

      added the new SMALL_PARCEL_VAT enum value to the // response property for the response status

  • d251e3228d00Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status