List transactions

Changed on

Stedi Core-compatible List Transactions. Drop-in replacement: point a Stedi 2023-08-01 client at https://<your-cair-host>/api/stedi/2023-08-01 and authenticate with your Cair access token.

Transactions are returned newest-first by processedAt. Every transaction that is visible to your organization is included regardless of how it entered Cair (stedi webhooks and uploaded / EOB-converted X12). Pages are traversed with the opaque nextPageToken; there is no offset paging.

get/api/stedi/2023-08-01/transactions

Request

  • Base URL
    https://forecaster.cairhealth.com
  • URL
    https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions
  • Auth
    HTTP bearer

Query parameters

pageSizeinteger

Maximum number of transactions to return in a page (1–500). Defaults to 100.

pageTokenstring

Opaque cursor returned as nextPageToken by a previous call. Supply it to fetch the next page. The cursor is bound to your organization and to the filter set it was minted with; reusing it with different filters returns 400.

transactionSetIdstring

List only a given X12 transaction type. Accepts any 3-digit X12 Transaction Set Identifier Code, e.g. 835, 837, 277.

direction'INBOUND' | 'OUTBOUND' | 'UNKNOWN'

Transaction direction. 837 claims are OUTBOUND; 835 remits and 277 statuses are INBOUND.

mode'test' | 'production' | 'other'

Whether the transaction carries test or production data (from ISA15).

status'succeeded' | 'failed'

Whether Cair was able to successfully process the transaction.

fromstring date-time

Inclusive lower bound on processedAt. ISO 8601 date-time, e.g. 2026-10-01T00:00:00Z.

tostring date-time

Inclusive upper bound on processedAt. ISO 8601 date-time.

businessIdentifierstring

List only transactions containing a business identifier with this value. Matches the transaction-level businessIdentifiers (for example the CLP-01 / CLM-01 patient control number, element 1028, or the TRN-02 / BHT-03 trace number, element 127), and falls back to the item patient control number / trace number for uploaded X12.

elementIdstring

Restrict businessIdentifier to a specific X12 element ID. May only be supplied together with businessIdentifier; supplying it alone returns 400.

partnershipIdstring

Accepted for Stedi compatibility and currently ignored. All Cair transactions are exchanged on Cair's shared Stedi connection.

senderstring

Accepted for Stedi compatibility and currently ignored. All Cair transactions use Cair-managed profile IDs.

receiverstring

Accepted for Stedi compatibility and currently ignored. All Cair transactions use Cair-managed profile IDs.

Response

A page of transactions.

nextPageTokenstring

Opaque cursor for the next page. Absent when this is the last page. Bound to the organization and the filter set.

Changes