v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Exception

List exceptions

Use this endpoint to retrieve all exceptions. You can filter the results by status, severity, assigned user, external system, and date range. The response uses cursor-based pagination.

get/v1/exceptions

Query parameters

status'OPEN' | 'ASSIGNED' | 'PENDING_RESOLUTION' | 'RESOLVED'

Filter by status

severity'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL'

Filter by severity

assigned_tostring

Filter by assigned user

external_system'JIRA' | 'SERVICENOW' | 'WEBHOOK'

Filter by external system

date_fromstring

Filter from date (RFC3339)

date_tostring

Filter to date (RFC3339)

cursorstring

The cursor value for retrieving the next page of results.

limitinteger

Number of items per page

sort_by'id' | 'created_at' | 'updated_at' | 'severity' | 'status'

The field used to sort the results.

sort_order'asc' | 'desc'

The order used to sort the results.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

Response

Indicates that the request was successful and the response contains the expected data.

hasMoreboolean
limitinteger
nextCursorstring
prevCursorstring

Example response

{
  "hasMore": true,
  "items": [
    {
      "assignedTo": "user@example.com",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "dueAt": "2025-01-20T10:30:00.000Z",
      "externalIssueId": "RECON-1234",
      "externalSystem": "JIRA",
      "id": "019c96a0-10d2-7134-ba5f-664142ee7052",
      "reason": "Amount mismatch detected",
      "resolutionNotes": "Resolved via force match",
      "resolutionReason": "BUSINESS_DECISION",
      "resolutionType": "FORCE_MATCH",
      "severity": "HIGH",
      "status": "OPEN",
      "transactionId": "019c96a0-10ce-75fc-a273-dc799079a99c",
      "updatedAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "limit": 20,
  "nextCursor": "eyJpZCI6IjEyMyJ9",
  "prevCursor": "eyJpZCI6IjEyMiJ9"
}