---
title: "Get filings"
method: GET
path: "/v1/filings"
tags: ["Filings"]
---

# Get filings

`GET /v1/filings`

The Get Filings API retrieves a paginated list of filings based on
    filters such as dates, jurisdiction, Country, status, etc. This helps track
    and manage tax filings efficiently across multiple jurisdictions.

## Query parameters

- `status__in` string, nullable — Filter filings by status
- `start_date` string, date, nullable — Filter filings with a start date greater than or equal to this date.
- `end_date` string, date, nullable — Filter filings with an end date less than or equal to this date.
- `date_filed__gte` string, date, nullable — Filter filings filed on or after this date.
- `date_filed__lte` string, date, nullable — Filter filings filed on or before this date.
- `order_by` string, nullable — Comma-separated list of fields to sort the results.
- `state_code` string, nullable — Filter filings by state code (e.g., CA for California).
- `country_code` union[], nullable — Filter filings by country code in ISO 3166-1 alpha-2 format (e.g., US).
  - 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
- `filing_category__in` string, nullable — Filter filings by category (e.g., REGULAR, BACK_FILING, AMENDMENT).
- `tax_type__in` string, nullable — Filter filings by tax type. Multiple tax types can be passed, separated by commas (SALES_TAX, USE_TAX, SALES_AND_USE_TAX).
- `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 filings

- PageFilingRead
  - `items` FilingRead[], required
    - `status` 'UNFILED' | 'FILED' | 'FILING' | 'PAUSED' | 'SKIPPED' | 'CANCELLED' | 'ISSUE'
    - `start_date` string, date, required — The start date of the filing period.
    - `end_date` string, date, required — The end date of the filing period.
    - `due_date` string, date, nullable — The due date of the filing.
    - `date_filed` string, date, nullable — The date the filing was completed, if applicable.
    - `is_manual` boolean, nullable — Indicates if the filing was done manually.
    - `state_code` string, nullable — The code of the state associated with the filing (e.g., IA, NY).
    - `state_name` string, nullable — The name of the state associated with the filing (e.g., Iowa, New York).
    - `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
    - `auto_approved` boolean, nullable — Indicates if the filing was auto-approved. Defaults to false.
    - `paused_until_date` string, date, nullable — Indicates the date when filing will be unpaused.
    - `filing_category` string — Category of filing. Common values: REGULAR (standard periodic filing), BACK_FILING (past-due period), AMENDMENT (amended return). Prepayment is ``is_prepayment``, not a category. Different categories can have overlapping periods.
    - `is_prepayment` boolean — True when this filing is a prepayment obligation. Independent of filing_category so a past-due prepayment can still be BACK_FILING.
    - `approved_by` string, nullable — User ID of who approved the filing.
    - `approved_at` string, date-time, nullable — Timestamp when the filing was approved.
    - `issue_reason` string, nullable — Reason why the filing has an issue, if applicable.
    - `skip_reason` string, nullable — Reason why the filing was skipped, if applicable.
    - `cancelled_reason` string, nullable — Reason why the filing was cancelled, if applicable.
    - `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.
    - `is_rdf` boolean — True when this filing is a state Retail Delivery Fee return, a separate filing from the state's sales tax return.
    - `amount_calculated` string — The calculated amount for the filing. Defaults to 0.00.
    - `amount_adjusted` string — Adjusted amount, if any.
    - `amount_discounts` string — Discounts applied to the filing.
    - `amount_fees` string — Fees applied to the filing.
    - `amount_penalties` string — Penalties applied to the filing.
    - `amount_tax_collected` string — Total tax collected during the filing period.
    - `amount_use_tax` string — Use tax liability for the filing period. Defaults to 0.00.
    - `amount_sales` string — Total sales amount during the filing period.
    - `total_taxable_sales` string, nullable — Total taxable amount during the filing period.
    - `amount` string — Final amount due for the filing.
    - `total_tax_liability` string — Total tax liability for the filing.
    - `transaction_count` integer — Number of non-marketplace transactions. For total, add marketplace_transaction_count.
    - `marketplace_transaction_count` integer — Number of marketplace transactions associated with the filing.
    - `estimated_line_count` integer, nullable — Estimated schedule line count (distinct jurisdictions). For Tax Ops workload ranking, not portal accuracy.
    - `internal_notes` string, nullable — Notes or comments related to the filing.
    - `recent_details_report_link` string, nullable
    - `tax_remitted` string — The amount of tax remitted.
    - `original_tax_remitted` string, nullable — Tax remitted when filing was first confirmed.
    - `return_confirmation_id` string, nullable — Return confirmation ID, if applicable.
    - `payment_confirmation_id` string, nullable — Payment confirmation ID, if applicable.
    - `block_approval` boolean, nullable — Indicates if the filing can be approved.
    - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD'
    - `id` string, required — Unique identifier for the filing.
    - `registration_id` string, required — Identifier for the registration associated with the filing.
    - `filing_frequency` string, nullable — Filing frequency from the associated registration.
    - `oss_type` string, nullable — OSS scheme (UNION/NON_UNION/IOSS) from the associated registration, if any.
    - `quarterly_prepay_balance` QuarterlyPrepayBalanceDisplay — Display-only balance-due breakdown for CA Quarterly Prepayment reconciliation. Populated only when the org has ``enable_ca_qp_tax_liability_display`` on and the filing is a CA ``QUARTERLY_PREPAYMENT`` ``REGULAR`` reconciliation with prepayment siblings. Does not change any stored amount on the filing.
      - `gross_tax_liability` string, required — The filing's stored full-quarter total_tax_liability.
      - `balance_due` string, required — gross_tax_liability minus the sum of prepayment deductions.
      - `prepayment_deductions` QuarterlyPrepayDeduction[] — The monthly prepayments netted out, ordered by period.
        - `label` string, required — Human-readable label, e.g. 'April prepayment'.
        - `amount` string, required — Prepayment tax liability subtracted from the quarter total.
        - `filing_id` string, required — Identifier of the monthly prepayment filing.
    - `ca_may_prepayment` CaMayPrepaymentDisplay — Display-only CDTFA Option 2 amount for CA May quarterly prepayment filings. Populated for CA ``QUARTERLY_PREPAYMENT`` ``PREPAYMENT`` filings whose period starts in May. Does not change any stored amount on the filing. See KA-1240.
      - `base_tax_liability` string, required — The filing's stored May total_tax_liability (100%).
      - `prepayment_amount` string, required — CDTFA Option 2 prepayment: base_tax_liability × 1.35.
      - `note` string, required — Explanatory note that the amount is 135% of May tax liability.
    - `estimated_penalty_interest` string, nullable — Display-only estimated penalties and interest for BACK_FILING rows. Null means unknown (placeholder). Zero is a genuine not-yet-late or zero-tax outcome. Never persisted on the filing or used for billing.
    - `penalty_interest_remittance_tag` string, nullable — Customer-facing P&I timing tag for BACK_FILING rows, e.g. 'Paid with return' or 'State bills you later'.
    - `filing_website_url` string, nullable, required — Get the filing website URL for this filing'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` — 19 breaking, 4 warning, 208 info
  - added the new required `header` request parameter `x-organization-id`
  - for the `query` request parameter `status__in`, default value was changed from `FILED,FILING,UNFILED,PAUSED` to `FILED,FILING,UNFILED,PAUSED,CANCELLED,ISSUE,SKIPPED`
  - response property `items/items/approved_at` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `items/items/approved_by` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - …227 more
  - …this revision’s changelog is incomplete

[Change history](https://skmtc.dev/trykintsugi/apis/tax-platform/changes/v1/filings/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)