KintsugiKintsugi

List filings

GET/filings

List filings, keyset-paginated. Covers every organization your credential owns; send an Organization-Id, Connection-Id or Entity-Id selector to narrow to one. Every list filter takes a comma-separated list and matches any of the values you send. Pass limit and the opaque cursor from a prior response's nextCursor/previousCursor to page. Pass sort and order to order the list; omit sort to keep the default order. None of the sort keys is index-backed, so sorting a large scope sorts the whole matching set. Pass expand=salesBreakdown, expand=vatRecovery and/or expand=artifacts to embed those buckets on each row; omitted otherwise. A cursor is only valid for the sort, the filters AND the organization scope it was issued under; change any of them and start again from the first page. expand does not affect which filings are returned, so a cursor stays valid whether or not you pass it. Filings marked do-not-file (skipped under an organization or registration do-not-file setting) are excluded from this list and from the summary counts.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Narrow the request to one organization (Organization-Id selector).

Connection-Idstring

Narrow the request to a connection's organization.

Entity-Idstring

Narrow the request to a platform entity's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

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.

/filings?expand=<expand>&limit=<limit>&cursor=<cursor>
expandFilingExpand[]

Buckets to embed on each filing. salesBreakdown embeds the period's sales composition; vatRecovery embeds the EU/UK input-VAT recovery rate pair; artifacts embeds the filing's return/payment/additional artifacts by slot. Omitted otherwise. Does not change which filings are returned.

Available options:salesBreakdownvatRecoveryartifacts
limitinteger

Maximum number of items to return.

cursorstring

Opaque cursor from a prior response's nextCursor or previousCursor. Omit for the first page.

sortPublicFilingSortEnum

Field to sort by. Omit to keep the default (id-ordered) ordering.

Available options:statuscountryCodestateCodestartDateendDatedateFiledamounttotalTaxLiability
orderPublicFilingSortOrder

Sort direction. Applies only when sort is set. Defaults to asc.

Available options:ascdesc
statusstring

Comma-separated lifecycle statuses; matches any of them.

countryCodestring

Comma-separated ISO 3166-1 alpha-2 country codes; matches any.

stateCodestring

Comma-separated state/province codes; matches any.

filingCategorystring

Comma-separated filing categories; matches any.

taxTypestring

Comma-separated tax types; matches any.

registrationIdstring

Only filings filed under this registration.

startDateGtestring

Only filings whose period starts on/after.

endDateGtestring

Only filings whose period ends on/after.

endDateLtestring

Only filings whose period ends on/before.

dateFiledGtestring

Only filings filed on/after.

dateFiledLtestring

Only filings filed on/before.

Response

itemsFiling[]Required

The filings on this page.

nextCursorstring

Opaque cursor for the next page. null when this is the last page. Send it back as cursor; do not parse it.

previousCursorstring

Opaque cursor for the previous page. null when this is the first page. Send it back as cursor; do not parse it.

hasMoreboolean

Whether a page exists after this one.

hasPreviousboolean

Whether a page exists before this one.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

409

The request conflicts with existing state.

422

The request failed validation.

cURL
GET /filings?expand=salesBreakdown&limit=50&cursor={cursor}
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
Example request
https://api.trykintsugi.com/filings?expand=salesBreakdown&limit=50&cursor={cursor}
Response
{
"items": [
{
"id": "file_2mNpQr7Ls8f3k",
"organizationId": "orgn_2mNpQr7Ls8f3k",
"organizationName": "Acme Corp",
"registrationId": "regs_2mNpQr7Ls8f3k",
"status": "UNFILED",
"filingCategory": "REGULAR",
"taxType": "SALES_TAX",
"countryCode": "US",
"stateCode": "CA",
"stateName": "Acme Corp",
"startDate": "2026-07-21",
"endDate": "2026-07-21",
"dueDate": "2026-07-21",
"dateFiled": "2026-07-21",
"returnConfirmationId": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"paymentConfirmationId": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"pausedUntilDate": "2026-07-21",
"isPausable": false,
"canApprove": true,
"skipReason": "Customer request",
"isPrepayment": false,
"isFinal": false,
"isRdf": false,
"transactionCount": 1,
"filingWebsiteUrl": "https://www.example.com",
"approvedAt": "2026-07-28T12:00:00Z",
"createdAt": "2026-07-28T12:00:00Z",
"currency": "USD",
"amount": "10.00",
"amountCalculated": "10.00",
"amountAdjusted": "10.00",
"amountDiscounts": "10.00",
"amountFees": "10.00",
"feeType": "PENALTY",
"amountPenalties": "10.00",
"amountTaxCollected": "10.00",
"amountUseTax": "10.00",
"amountSales": "10.00",
"totalTaxLiability": "10.00",
"taxRemitted": "10.00",
"amountInputVatRecoverable": "10.00",
"amountInputVatTrueUp": "10.00",
"filingFrequency": "UNKNOWN",
"ossType": "UNION",
"quarterlyPrepayBalance": {
"grossTaxLiability": "10.00",
"balanceDue": "10.00",
"prepaymentDeductions": [
{
"label": "April prepayment",
"amount": "10.00",
"filingId": "file_2mNpQr7Ls8f3k"
}
]
},
"caMayPrepayment": {
"baseTaxLiability": "10.00",
"prepaymentAmount": "10.00",
"note": "Reviewed and approved."
},
"estimatedPenaltyInterest": "10.00",
"penaltyInterestRemittanceTag": "penalty interest remittance tag",
"salesBreakdown": {
"totalTaxableSales": "10.00",
"exemptSales": "10.00",
"marketplaceTransactionCount": 1,
"creditsUtilized": "10.00",
"deferredTransactionCount": 1
},
"vatRecovery": {
"inputVatRecoveryRate": "10.00",
"inputVatRecoveryRateIsDefinitive": false
},
"filingArtifacts": {
"returnArtifact": {
"id": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"fileName": "certificate.pdf"
},
"paymentArtifact": {
"id": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"fileName": "certificate.pdf"
},
"additionalArtifacts": [
{
"id": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"fileName": "certificate.pdf"
}
]
}
}
],
"nextCursor": "eyJpZCI6InRyYW5fMm1OcFFyN0xzOGYzayJ9",
"previousCursor": "eyJpZCI6InRyYW5fMm1OcFFyN0xzOGYzayJ9",
"hasMore": false,
"hasPrevious": false
}
List filings (2026-07-21) | Kintsugi API Reference