--- title: "Get registrations" method: GET path: "/v1/registrations" tags: ["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. ## Query parameters - `status__in` string — 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` union[], nullable — Filter registrations by country code in ISO 3166-1 alpha-2 format (e.g., US, CA). - union - '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' - string - `tax_type__in` string, nullable — Filter registrations by tax type. Multiple tax types can be passed, separated by commas (SALES_TAX, USE_TAX, SALES_AND_USE_TAX). - `order_by` string, nullable — Order results by specified fields (comma-separated) - `page` integer — Page number - `size` integer — Page size ## Headers - `x-organization-id` string, nullable, required — The unique identifier for the organization making the request ## Response `200` Successfully retrieved registrations - PageRegistrationReadWithPassword - `items` RegistrationReadWithPassword[], required - `registration_date` string, date, nullable — The date when the registration was created. Format: YYYY-MM-DD. - `registration_email` string, nullable — Email address associated with the registration. - `registration_requested` string, date-time, nullable — Timestamp when the registration was requested. - `registration_completed` string, date-time, nullable — Timestamp when the registration was completed. - `deregistration_requested` string, date-time, nullable — Timestamp when deregistration was requested. - `deregistration_completed` string, date-time, nullable — Timestamp when the deregistration was completed. - `auto_registered` boolean, nullable — Indicates whether the registration was completed automatically. - `registrations_regime` 'STANDARD' | 'SIMPLIFIED' - `change_regime_status` 'REQUESTED' | 'APPROVED' | 'DONE' | 'ACKNOWLEDGED' - `third_party_enabled` boolean, nullable — Indicates whether third-party access is enabled for this registration. - `do_not_file` boolean — If true, do not file for this registration (treated as False by default). - `two_factor_enabled` boolean, nullable — Indicates whether two-factor authentication (2FA) is enabled for this registration. - `marked_collecting` boolean, nullable — Indicates whether the registration is marked as collecting in shopify - `status` 'REGISTERED' | 'PROCESSING' | 'UNREGISTERED' | 'DEREGISTERING' | 'DEREGISTERED' | 'CANCELLED' | 'VALIDATING' | 'AWAITING_CLARIFICATION' | 'SELF_MANAGED', required - `country_code` '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', required - `state_code` string, required — The state/province code where the registration applies. - `state_name` string, required — The name of the state/province. - `filing_frequency` 'UNKNOWN' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'ANNUALLY' | 'ANNUAL_FISCAL_YEAR' | 'SEMI_MONTHLY' | 'BI_MONTHLY' | 'FOUR_MONTHLY' | 'QUARTERLY_PREPAYMENT', required - `initial_filing_frequency` 'UNKNOWN' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'ANNUALLY' | 'ANNUAL_FISCAL_YEAR' | 'SEMI_MONTHLY' | 'BI_MONTHLY' | 'FOUR_MONTHLY' | 'QUARTERLY_PREPAYMENT' - `scheduled_filing_frequency` 'UNKNOWN' | 'MONTHLY' | 'QUARTERLY' | 'SEMI_ANNUALLY' | 'ANNUALLY' | 'ANNUAL_FISCAL_YEAR' | 'SEMI_MONTHLY' | 'BI_MONTHLY' | 'FOUR_MONTHLY' | 'QUARTERLY_PREPAYMENT' - `filing_frequency_effective_date` string, date, nullable — The date on which `scheduled_filing_frequency` should automatically become the registration's `filing_frequency`. Null when no frequency change is pending. - `username` string, nullable — Username for accessing tax registration details. - `comment` string, nullable — Additional comments related to the registration. - `create_filings_from` string, date, nullable — The date from which filings should be created. should start (YYYY-MM-DD). - `create_back_filing` boolean — Whether to also file the single period preceding the first filing period. - `retail_delivery_fee_obligated` boolean — Whether this registration is declared obligated to file a Retail Delivery Fee return (e.g. Colorado DR 1786). - `retail_delivery_fee_effective_from` string, date, nullable — First date from which retail delivery fee filings may be generated. Periods that closed before this date must not get those filings. - `initial_sync` boolean, nullable — Indicates whether an initial synchronization should be performed. - `amount_fees` string — The amount of fees associated with the registration. - `vda` boolean, nullable — Indicates whether a Voluntary Disclosure Agreement (VDA) applies. - `imported` boolean, nullable — Whether the registration was imported from another system. - `sales_tax_id` string, nullable — Account number for this registration. Holds the sales tax ID on a sales or combined permit, and the consumer use tax account number on a use tax registration. - `ior_number` string, nullable — The Importer of Record (IOR) number associated with the registration. - `ior_date` string, date, nullable — The date the Importer of Record (IOR) became effective (YYYY-MM-DD). For jurisdictions where tax collection starts after the IOR date rather than the registration date, this is the date on/after which tax is collected. - `sst_import` boolean, nullable — Indicates whether the registration is an SST Import. - `oss_type` 'UNION' | 'NON_UNION' | 'IOSS' — Type of OSS registration. - `oss_member_state_of_identification_code` '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' - `tax_type` 'SALES_TAX' | 'USE_TAX' | 'SALES_AND_USE_TAX' — Tax obligation on a nexus, registration, or filing row. Registrations and filings may be SALES_AND_USE_TAX: one state account and one return can cover both taxes, and each is stored as a single row. Nexus rows are only SALES_TAX or USE_TAX. Sales and use tax exposure are separate obligations with their own met dates, period models, and liability accrual. - `marked_collecting_date` string, date-time, nullable — The date when the registration was marked as collecting. - `needs_mark_as_collecting` boolean, nullable — Indicates whether the registration needs to be marked as collecting. - `id` string, required — The unique identifier for the registration. - `created_at` string, date-time, nullable — Timestamp when this registration was created in Kintsugi. - `credits_total_available` string - `registration_category` 'REGULAR' | 'IMPORTED' | 'DEREGISTRATION' - `jurisdiction_specific_fields` object, nullable — Jurisdiction-specific registration fields. - `password_encrypted` string, binary, nullable — Encrypted password for accessing the registration, if applicable. - `pin_encrypted` string, binary, nullable — Encrypted PIN for the registration (e.g. Arizona/Wyoming e-file PIN). Masked by default; decrypted only when explicitly revealed via the GET registration endpoint's reveal query. - `has_all_credentials` boolean — Indicates if all required credentials are present. - `filing_days` integer, required - `registration_type` 'EU_OSS' | 'OTHER', required - `filing_website_url` string, nullable, required — State tax portal URL for this registration's jurisdiction. - `total` integer, required - `page` integer, required - `size` integer, required - `pages` integer, required ## Other responses - `401` — Unauthenticated request. - `404` — Resource not found - `422` — Validation error - `500` — Internal server error ## Changes - **2026-08-29** `6ba4f4c774c3` — 27 breaking, 4 warning, 285 info - added the new required `header` request parameter `x-organization-id` - for the `query` request parameter `status__in`, default value was changed from `REGISTERED,PROCESSING,UNREGISTERED,DEREGISTERING,DEREGISTERED,VALIDATING,AWAITING_CLARIFICATION` to `REGISTERED,PROCESSING,UNREGISTERED,DEREGISTERING,DEREGISTERED,CANCELLED,VALIDATING,AWAITING_CLARIFICATION,SELF_MANAGED` - response property `items/items/auto_registered` list-of-types was widened by adding types `null` to media type `application/json` of response `200` - response property `items/items/comment` list-of-types was widened by adding types `null` to media type `application/json` of response `200` - …312 more - …this revision’s changelog is incomplete [Change history](https://skmtc.dev/trykintsugi/apis/tax-platform/changes/v1/registrations/get.md) --- [API](https://skmtc.dev/trykintsugi/apis/tax-platform.md) · [All operations](https://skmtc.dev/trykintsugi/apis/tax-platform/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/trykintsugi/tax-platform/revisions/6ba4f4c774c3/schema)