KintsugiKintsugi

List transactions

GET/transactions

List transactions, keyset-paginated. Covers every organization your credential owns; send an Organization-Id, Connection-Id or Entity-Id selector to narrow to one. Archived and duplicate transactions are never returned. Filter with the query params (countryCode, stateCode, dateFrom, collectedTax, includeRefunds, and the existing list filters) and sort with sort / order (default date descending, so newest first). A cursor is only valid for the sort, the filters AND the organization scope it was issued under, including any selector header: change any of them and start again from the first page.

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.

/transactions?sort=<sort>&order=<order>&limit=<limit>
sortPublicTransactionSortEnum

Field to sort by. Defaults to date.

Available options:datetotalAmountstatuscountry
orderPublicTransactionSortOrder

Sort direction. Defaults to desc, so newest first.

Available options:ascdesc
limitinteger

Maximum number of items to return.

cursorstring

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

searchstring

Free-text search over transaction id, externalId, externalFriendlyId, description and customer name.

startDatestring

Include transactions on or after this date (YYYY-MM-DD).

endDatestring

Include transactions on or before this date (YYYY-MM-DD).

statusstring

Comma-separated transaction statuses; matches any of them.

refundStatusstring

Comma-separated refund statuses; matches any of them.

sourcestring

Comma-separated source systems; matches any of them.

typestring

Comma-separated transaction type filters; matches any of them. CREDIT_NOTE groups every credit-note type; SALES_ORDER filters sales orders.

addressStatusstring

Comma-separated address statuses; matches any of them.

connectionIdstring

Comma-separated connection ids; matches any of them. This filters rows by connection. To restrict which organization is read, send the Connection-Id header instead.

countrystring

Comma-separated ISO-3166 country codes; matches any of them.

statestring

Comma-separated state or province codes; matches any of them.

directionPublicTransactionDirectionEnum

Restrict to sales or purchases. Omit to return both, matching the unfiltered list.

Available options:SALEPURCHASE
marketplaceboolean

Restrict to marketplace (true) or non-marketplace (false) rows.

filingIdstring

Restrict to transactions assigned to this filing.

exemptstring

Comma-separated exemption statuses; matches any of them.

processingStatusstring

Comma-separated processing statuses; matches any of them.

countryCodestring

ISO-3166-1 alpha-2 country code. Combined with country when both are sent. Use with collectedTax=true and ZZ_EU to match EU member-state collected tax.

stateCodestring

State or province code. Requires countryCode or country. When collectedTax=true, FD (federal nexus sentinel) is not applied as a state filter, and ZZ_EU also drops stateCode.

dateFromstring

Inclusive YYYY-MM-DD floor on transaction date. Combined with startDate when both are sent by taking the later of the two.

collectedTaxboolean

When true, restrict to sales with imported tax in the requested jurisdiction (verified address, not marketplace, not credit notes unless includeRefunds).

includeRefundsboolean

When collectedTax is true, include credit notes with nonzero imported tax. Ignored otherwise.

hasCountryboolean

Filter by whether the transaction address has a country. true keeps rows with a country, false keeps rows missing one.

hasStateboolean

Filter by whether the transaction address has a state or province. true keeps rows with one, false keeps rows missing one (an empty value counts as missing).

hasCityboolean

Filter by whether the transaction address has a city. true keeps rows with one, false keeps rows missing one (an empty value counts as missing).

hasCountyboolean

Filter by whether the transaction address has a county. true keeps rows with one, false keeps rows missing one (an empty value counts as missing).

hasPostalCodeboolean

Filter by whether the transaction address has a postal code. true keeps rows with one, false keeps rows missing one (an empty value counts as missing).

addressNotEmptyboolean

When true, hide fully-empty addresses (rows where state, city, postal code and county are all missing). When false, keep only those fully-empty addresses.

Response

itemsTransaction[]Required

The transactions on this page.

nextCursorstring

Opaque cursor for the next page, or null on the last page. Pass it back as cursor.

previousCursorstring

Opaque cursor for the previous page, or null on the first page. Pass it back as cursor.

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 /transactions?sort=date&order=asc&limit=50
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
Example request
https://api.trykintsugi.com/transactions?sort=date&order=asc&limit=50
Response
{
"items": [
{
"id": "tran_2mNpQr7Ls8f3k",
"organizationId": "orgn_2mNpQr7Ls8f3k",
"externalId": "order-1001",
"externalFriendlyId": "INV-1001",
"date": "2026-07-28T12:00:00Z",
"type": "SALE",
"status": "PENDING",
"direction": "SALE",
"customerId": "cust_2mNpQr7Ls8f3k",
"customerName": "Acme Corp",
"connectionId": "conn_2mNpQr7Ls8f3k",
"source": "API",
"description": "Annual software subscription",
"currency": "AED",
"totalAmount": "10.00",
"taxableAmount": "10.00",
"totalTaxAmountImported": "10.00",
"totalTaxAmountCalculated": "10.00",
"totalTaxLiabilityAmount": "10.00",
"totalDiscount": "10.00",
"finalTotalAmount": "10.00",
"hasExemptions": false,
"locked": false,
"marketplace": false,
"shopDate": "2026-07-21",
"processingStatus": "PROCESSED",
"taxLiabilitySource": "CALCULATED",
"addressStatus": "UNVERIFIED",
"destinationCurrency": "AED",
"conversionRate": "25350.123456789",
"convertedTotalAmount": "10.00",
"convertedTotalTaxLiabilityAmount": "10.00",
"convertedTotalDiscount": "10.00",
"convertedFinalTotalAmount": "10.00",
"createdAt": "2026-07-28T12:00:00Z",
"updatedAt": "2026-07-28T12:00:00Z",
"addresses": [
{
"id": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"type": "BILL_TO",
"street1": "123 Main St",
"street2": "Suite 400",
"city": "San Francisco",
"county": "San Francisco County",
"state": "CA",
"postalCode": "94107",
"country": "US",
"fullAddress": "123 Main St, San Francisco, CA 94107, US",
"phone": "+1 415 555 0100",
"status": "UNVERIFIED"
}
],
"items": [
{
"id": "txim_2mNpQr7Ls8f3k",
"productId": "prod_2mNpQr7Ls8f3k",
"productName": "Widget",
"description": "Annual software subscription",
"quantity": "3",
"amount": "10.00",
"subtotal": "10.00",
"discount": "10.00",
"taxAmountImported": "10.00",
"taxAmountCalculated": "10.00",
"taxLiabilityAmount": "10.00",
"exempt": false,
"convertedAmount": "10.00",
"convertedSubtotal": "10.00",
"convertedDiscount": "10.00",
"convertedTaxAmountImported": "10.00",
"convertedTaxLiabilityAmount": "10.00",
"taxItems": [
{
"name": "CA STATE TAX",
"rate": "0.082500000",
"amount": "10.00",
"convertedAmount": "10.00",
"jurisdictionType": "STATE",
"jurisdictionName": "CA"
}
]
}
]
}
],
"nextCursor": "eyJpZCI6InRyYW5fMm1OcFFyN0xzOGYzayJ9",
"previousCursor": "eyJpZCI6InRyYW5fMm1OcFFyN0xzOGYzayJ9",
"hasMore": false,
"hasPrevious": false
}
List transactions (2026-07-21) | Kintsugi API Reference