EDI Transactions (Stedi-Compatible)

List Transactions

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

List transactions

curl --request GET \
  --url https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "transactionId": "c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6",
      "fileExecutionId": "b0a1c2d3e4f5a6b7c8d9e0f1a2b3c4d5",
      "status": "succeeded",
      "direction": "INBOUND",
      "mode": "production",
      "processedAt": "2026-10-05T14:12:00.000Z",
      "artifacts": [
        {
          "artifactType": "application/edi-x12",
          "usage": "input",
          "sizeBytes": 2048,
          "url": "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6/input",
          "model": "transaction"
        },
        {
          "artifactType": "application/json",
          "usage": "output",
          "sizeBytes": 8192,
          "url": "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6/output",
          "model": "transaction"
        }
      ],
      "partnership": {
        "partnershipId": "local-clearinghouse",
        "partnershipType": "x12",
        "sender": {
          "profileId": "local"
        },
        "receiver": {
          "profileId": "clearinghouse"
        }
      },
      "businessIdentifiers": [
        {
          "elementId": "1028",
          "element": "CLP-01",
          "name": "Patient Control Number",
          "value": "PCN123456"
        }
      ],
      "x12": {
        "metadata": {
          "interchange": {
            "acknowledgmentRequestedCode": "0",
            "controlNumber": 42
          },
          "functionalGroup": {
            "controlNumber": 1,
            "release": "005010X221A1",
            "date": "2026-10-05",
            "time": "14:12:00",
            "functionalIdentifierCode": "HP"
          },
          "transaction": {
            "controlNumber": "0001",
            "transactionSetIdentifier": "835"
          },
          "sender": {
            "applicationCode": "ZZ",
            "isa": {
              "qualifier": "ZZ",
              "id": "SUBMITTER"
            }
          },
          "receiver": {
            "applicationCode": "ZZ",
            "isa": {
              "qualifier": "ZZ",
              "id": "RECEIVER"
            }
          }
        }
      }
    }
  ],
  "nextPageToken": "be08e5ba4bf36da9da27dcb651e64a6e5502685499994f354"
}

{
  "message": "<string>",
  "code": "BadRequestException"
}

{
  "message": "<string>",
  "code": "BadRequestException"
}

{
  "message": "<string>",
  "code": "BadRequestException"
}

Overview

Returns your organization’s processed transactions, newest first by processedAt. This is a 1:1 drop-in for Stedi’s List Transactions operation. Results include every source (stedi webhooks, uploaded X12, and EOB-converted X12) that your organization can see. Use it to build transaction browsers, reconciliations, or backfills; use Poll Transactions to follow the stream incrementally.

Authentication

JWT Bearer token from POST /api/token, with the api-access feature.

Query parameters

integer

default:"100"

Number of transactions per page, 1–500. Values outside the range return 400.

string

Opaque cursor from a previous response’s nextPageToken. It is bound to your organization and to the filters it was minted with; changing filters mid-pagination returns 400.

string

Restrict to one X12 transaction type. Accepts any 3-digit Transaction Set Identifier Code: 835 (remit), 837 (claim), 277 (claim status), and others.

string

INBOUND, OUTBOUND, or UNKNOWN. 837 claims are OUTBOUND; 835 remits and 277 statuses are INBOUND.

string

test, production, or other (from ISA15).

string

succeeded or failed.

string

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

string

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

string

Restrict to transactions containing a matching business identifier. Matches the transaction’s businessIdentifiers (for example the patient control number CLP-01 / CLM-01, element 1028, or the trace number TRN-02 / BHT-03, element 127) and falls back to the item patient control number / trace number for uploaded X12.

string

Restrict businessIdentifier to one X12 element ID (e.g. 1028 or 127). May only be supplied together with businessIdentifier; supplying it alone returns 400.

string

Accepted for Stedi compatibility and ignored. All Cair transactions use Cair’s shared Stedi connection.

string

Accepted for Stedi compatibility and ignored.

string

Accepted for Stedi compatibility and ignored.

Example

Fetch the first page of 835 remits:

curl "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions?transactionSetId=835&pageSize=50" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Walk every page:

let pageToken: string | undefined;
const transactions: unknown[] = [];

do {
  const url = new URL('https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions');
  url.searchParams.set('transactionSetId', '835');
  if (pageToken) url.searchParams.set('pageToken', pageToken);

  const response = await fetch(url, {
    headers: { Authorization: `Bearer ${process.env.CAIR_ACCESS_TOKEN}` },
  });
  if (!response.ok) throw new Error(await response.text());

  const page = await response.json();
  transactions.push(...page.items);
  pageToken = page.nextPageToken;
} while (pageToken);

Response

{
  "items": [
    {
      "transactionId": "c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6",
      "fileExecutionId": "b0a1c2d3e4f5a6b7c8d9e0f1a2b3c4d5",
      "status": "succeeded",
      "direction": "INBOUND",
      "mode": "production",
      "processedAt": "2026-10-05T14:12:00.000Z",
      "artifacts": [
        {
          "artifactType": "application/edi-x12",
          "usage": "input",
          "sizeBytes": 2048,
          "url": "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6/input",
          "model": "transaction"
        },
        {
          "artifactType": "application/json",
          "usage": "output",
          "sizeBytes": 8192,
          "url": "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6/output",
          "model": "transaction"
        }
      ],
      "partnership": {
        "partnershipId": "local-clearinghouse",
        "partnershipType": "x12",
        "sender": { "profileId": "local" },
        "receiver": { "profileId": "clearinghouse" }
      },
      "businessIdentifiers": [
        {
          "elementId": "1028",
          "element": "CLP-01",
          "name": "Patient Control Number",
          "value": "PCN123456"
        }
      ],
      "x12": {
        "metadata": {
          "interchange": { "acknowledgmentRequestedCode": "0", "controlNumber": 42 },
          "functionalGroup": {
            "controlNumber": 1,
            "release": "005010X221A1",
            "date": "2026-10-05",
            "time": "14:12:00",
            "functionalIdentifierCode": "HP"
          },
          "transaction": { "controlNumber": "0001", "transactionSetIdentifier": "835" },
          "sender": { "applicationCode": "ZZ", "isa": { "qualifier": "ZZ", "id": "SUBMITTER" } },
          "receiver": { "applicationCode": "ZZ", "isa": { "qualifier": "ZZ", "id": "RECEIVER" } }
        }
      }
    }
  ],
  "nextPageToken": "be08e5ba4bf36da9da27dcb651e64a6e5502685499994f354"
}

Pagination

nextPageToken is present only when there are more matching transactions. When it is absent, you have reached the end.
Always pass the token back with the same filters; the token records a hash of the filter set and a mismatch returns 400 Bad RequestException.
Tokens are opaque. Do not parse, modify, or persist them across filter changes.

See the Transaction Stream Overview for the TransactionSummary field reference and the shared error model.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

pageSize

integer

default:100

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

Required range: 1 <= x <= 500

pageToken

string

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.

transactionSetId

string

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

Pattern: ^\d{3}$

direction

enum<string>

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

Available options:

INBOUND,

OUTBOUND,

UNKNOWN

mode

enum<string>

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

Available options:

test,

production,

other

status

enum<string>

Whether Cair was able to successfully process the transaction.

Available options:

succeeded,

failed

from

string<date-time>

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

string<date-time>

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

businessIdentifier

string

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.

elementId

string

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

partnershipId

string

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

sender

string

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

receiver

string

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

Response

A page of transactions.

items

object[]

required

Show child attributes

nextPageToken

string

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

List transactions

curl --request GET \
  --url https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "transactionId": "c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6",
      "fileExecutionId": "b0a1c2d3e4f5a6b7c8d9e0f1a2b3c4d5",
      "status": "succeeded",
      "direction": "INBOUND",
      "mode": "production",
      "processedAt": "2026-10-05T14:12:00.000Z",
      "artifacts": [
        {
          "artifactType": "application/edi-x12",
          "usage": "input",
          "sizeBytes": 2048,
          "url": "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6/input",
          "model": "transaction"
        },
        {
          "artifactType": "application/json",
          "usage": "output",
          "sizeBytes": 8192,
          "url": "https://forecaster.cairhealth.com/api/stedi/2023-08-01/transactions/c1f2e3d4a5b6c7d8e9f0a1b2c3d4e5f6/output",
          "model": "transaction"
        }
      ],
      "partnership": {
        "partnershipId": "local-clearinghouse",
        "partnershipType": "x12",
        "sender": {
          "profileId": "local"
        },
        "receiver": {
          "profileId": "clearinghouse"
        }
      },
      "businessIdentifiers": [
        {
          "elementId": "1028",
          "element": "CLP-01",
          "name": "Patient Control Number",
          "value": "PCN123456"
        }
      ],
      "x12": {
        "metadata": {
          "interchange": {
            "acknowledgmentRequestedCode": "0",
            "controlNumber": 42
          },
          "functionalGroup": {
            "controlNumber": 1,
            "release": "005010X221A1",
            "date": "2026-10-05",
            "time": "14:12:00",
            "functionalIdentifierCode": "HP"
          },
          "transaction": {
            "controlNumber": "0001",
            "transactionSetIdentifier": "835"
          },
          "sender": {
            "applicationCode": "ZZ",
            "isa": {
              "qualifier": "ZZ",
              "id": "SUBMITTER"
            }
          },
          "receiver": {
            "applicationCode": "ZZ",
            "isa": {
              "qualifier": "ZZ",
              "id": "RECEIVER"
            }
          }
        }
      }
    }
  ],
  "nextPageToken": "be08e5ba4bf36da9da27dcb651e64a6e5502685499994f354"
}

{
  "message": "<string>",
  "code": "BadRequestException"
}

{
  "message": "<string>",
  "code": "BadRequestException"
}

{
  "message": "<string>",
  "code": "BadRequestException"
}

Overview

API Authentication

Eligibility

Enrollments/Providers

Claims

EDI Transactions (Stedi-Compatible)

Claim AI Actions

Patient Chart Analysis

Patient Payments

Patients

Webhooks

AI Phone Calls

List Transactions

Overview

Authentication

Query parameters

Example

Response

Authorizations

Query Parameters

Response

​Overview

​Authentication

​Query parameters

​Example

​Response

​Pagination

Authorizations

Query Parameters

Response

Overview

Authentication

Query parameters

Example

Response

Pagination