Skip to main content
GET
/
v1
/
registrations
Get Registrations
curl --request GET \
  --url https://api.trykintsugi.com/v1/registrations \
  --header 'X-API-KEY: <api-key>' \
  --header 'x-organization-id: <api-key>'
{
  "items": [
    {
      "registration_date": "2024-01-01",
      "registration_email": "example@company.com",
      "status": "REGISTERED",
      "registration_key": "TO-1234",
      "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_key": "TO-5678",
      "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
}

Authorizations

​
X-API-KEY
string
header
required
​
x-organization-id
string
header
required

Query Parameters

​
status__in
string
default:REGISTERED,PROCESSING,UNREGISTERED,DEREGISTERING,DEREGISTERED,VALIDATING,AWAITING_CLARIFICATION

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

​
state_code
string

Filter registrations by state code.

​
filing_frequency__in
string

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

​
country_code__in
enum<string>[]

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

Available options:
AF,
AX,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BQ,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
CV,
KH,
CM,
CA,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CD,
CK,
CR,
HR,
CU,
CW,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
SZ,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IM,
IL,
IT,
CI,
JM,
JP,
JE,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
ME,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
MK,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RW,
BL,
SH,
KN,
LC,
MF,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
RS,
SC,
SL,
SG,
SX,
SK,
SI,
SB,
SO,
ZA,
GS,
SS,
ES,
LK,
SD,
SR,
SJ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
US,
UM,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW,
XK,
ZZ_EU
​
order_by
string

Order results by specified fields (comma-separated)

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

Successfully retrieved registrations

​
items
RegistrationReadWithPassword · object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1
​
pages
integer
required
Required range: x >= 0