Transactions

List the caller's EDI transactions with Control Layer filters and cursor pagination.

Tenant-scoped keyset pagination (newest first by default). An API key lists only its own lane; a dashboard session may pass environment. documentId restricts the list to the transactions linked to one canonical document (the receipt's links.transactions): doc_out_… resolves the transactions dispatched for that outbound document, doc_in_… the transactions parsed from that inbound file, doc_lab_… the Lab transaction itself; the document must be readable by the caller in its exact lane. Throttled at 120 calls per minute per API key.

get/v1/transactions

Request

  • Base URL: https://signaledi.com/api
  • URL: https://signaledi.com/api/v1/transactions
  • Auth: HTTP bearer

Query parameters

limitinteger

Max rows to return (clamped server-side to 1-100).

cursorstring

Opaque nextCursor from the previous page.

documentIdstring

Canonical document id (doc_out_…, doc_in_…, or doc_lab_…). Only the transactions linked to that document are returned. A malformed id is a 400 VALIDATION_ERROR; a document the caller cannot read in its lane is a 404 DOCUMENT_NOT_FOUND. Dashboard sessions must also pass environment.

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'REJECTED' | 'REPROCESSING' | 'ARCHIVED' | 'DELETED'
direction'INBOUND' | 'OUTBOUND'
documentTypestring

Transaction set or message code (transactionSet is accepted as an alias).

partnerIdstring
businessReferencestring

Case-insensitive substring match on the business reference.

searchstring

Case-insensitive substring match across business reference, control numbers, partner name, and error message.

dateFromstring date-time
dateTostring date-time
ackStatus'overdue' | 'pending' | 'unacknowledged' | 'accepted' | 'accepted_with_errors' | 'rejected'
errorClassstring
environment'LAB' | 'CERTIFICATION' | 'PRODUCTION'

The exact isolated lane identifier. The API route and payload remain the same. Lab is customer-to-Signal only; Certification uses the real third-party test route; Production is approved live exchange. SANDBOX is a historical request-only alias for Certification. Promotion creates an approved immutable version and never relabels traffic.

Dashboard sessions only. An API key is bound to its lane; a different value is a 403 ENVIRONMENT_MISMATCH.

sort'createdAt_desc' | 'createdAt_asc'

Response

Transaction summaries plus cursor page state.

oktrue required
nextCursorstring nullable required

Pass as cursor to fetch the next page; null on the last page.

hasMoreboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.