KintsugiKintsugi

List proposals

GET/proposals

List the proposals Kintsugi sent, newest first by createdAt, keyset-paginated. Each proposal shows when it was sent and decided and, once accepted, what happened next. Covers every organization your credential can access; pass an Organization-Id, Connection-Id or Entity-Id selector to narrow to one. Pass limit and the opaque cursor from a prior response's nextCursor or previousCursor to page. A cursor is only valid for the filter and organization scope it was issued under.

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.

/proposals?status=<status>&limit=<limit>&cursor=<cursor>
statusPublicProposalStatusEnum

Only return proposals in this status.

Available options:AWAITING_CUSTOMERAPPROVEDDECLINED
limitinteger

Maximum number of items to return.

cursorstring

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

Response

itemsProposal[]Required

The proposals 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 /proposals?status={status}&limit=50&cursor={cursor}
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
Example request
https://api.trykintsugi.com/proposals?status={status}&limit=50&cursor={cursor}
Response
{
"items": [
{
"id": "prop_8fKd2Wq7Ts3Jn",
"organizationId": "orgn_3bHq7Yt1Vc6Xe",
"subType": "BALANCE_DUE",
"status": "AWAITING_CUSTOMER",
"detail": "Washington shows an unpaid balance for June 2026.",
"declineReason": null,
"currency": "AED",
"items": [
{
"id": "prit_2xTq9Lm4Rk8Vp",
"stateCode": "WA",
"periodYear": 2026,
"periodMonth": 6,
"amount": "10.00",
"linkedFilingId": null
}
],
"createdAt": "2026-10-01T11:40:00Z",
"sentAt": "2026-07-28T12:00:00Z",
"decidedAt": "2026-07-28T12:00:00Z",
"outcome": {
"kind": "PAYMENT_IN_PROGRESS",
"amountPaid": "10.00",
"paidAt": "2026-07-28T12:00:00Z",
"paymentConfirmationAttachmentIds": [
"atch_7bQd3Np2Kx5Mw"
],
"backFilingCount": null
}
}
],
"nextCursor": "eyJpZCI6InRyYW5fMm1OcFFyN0xzOGYzayJ9",
"previousCursor": "eyJpZCI6InRyYW5fMm1OcFFyN0xzOGYzayJ9",
"hasMore": false,
"hasPrevious": false
}
List proposals (2026-07-21) | Kintsugi API Reference