List cases

GET

/v2/cases/organization/:organizationId

GET

/api/v2/cases/organization/:organizationId

$ curl -G https://api-sandbox.payabli.com/api/v2/cases/organization/123 \
>      -d fromRecord=0 \
>      -d limitRecord=20

1 {
2   "summary": {
3     "totalRecords": 1,
4     "totalAmount": 0,
5     "totalNetAmount": 0,
6     "totalPages": 1,
7     "pageSize": 20,
8     "pageidentifier": null
9   },
10   "records": [
11     {
12       "uuid": "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70",
13       "state": "PendingCompletion",
14       "caseType": "BankAccountChange",
15       "parameters": {
16         "type": "BankAccountChange",
17         "nickname": "Main Settlement Account",
18         "bankName": "First National Bank",
19         "bankToken": "bnk_2b1c9e40f5a34c9a8f219e7c6b1a2d34",
20         "accountType": "Checking",
21         "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
22         "bankAccountHolderType": "business",
23         "bankAccountFunction": "Deposits",
24         "services": {
25           "moneyIn": [
26             "Ach"
27           ],
28           "moneyOut": [
29             "Ach"
30           ]
31         },
32         "default": true
33       },
34       "orgId": 123,
35       "paypointId": 3040,
36       "scheduleFor": null,
37       "createdAt": "2026-01-15T10:30:00Z",
38       "updatedAt": "2026-01-15T10:30:43Z",
39       "createdBy": 0,
40       "assigneeId": null,
41       "lastReviewedById": null,
42       "stateHistory": [],
43       "attachments": [],
44       "roomId": 96369,
45       "metadata": null,
46       "org": {
47         "id": 123,
48         "name": "Example Partner Org"
49       },
50       "paypoint": {
51         "id": 3040,
52         "name": "Gruzya Adventure Outfitters"
53       },
54       "createdByUser": null,
55       "assignee": null,
56       "lastReviewedBy": null
57     }
58   ]
59 }

Lists cases for an organization, climbing the platform org hierarchy. Supports pagination and sorting through query parameters, and filtering through repeatable parameters[field(op)]=value query parameters (for example parameters[state(in)]=Assigned|PendingReview). Filterable fields include state, caseType, paypointId, createdAt, updatedAt, scheduleFor, and createdBy.

Available to both Platform and Enterprise Partners.

Lists cases for an organization, climbing the platform org hierarchy. Supports pagination and sorting through query parameters, and filtering through repeatable `parameters[field(op)]=value` query parameters (for example `parameters[state(in)]=Assigned|PendingReview`). Filterable fields include `state`, `caseType`, `paypointId`, `createdAt`, `updatedAt`, `scheduleFor`, and `createdBy`. Available to both Platform and Enterprise Partners.

Path parameters

organizationIdlongRequired

The organization's numeric identifier.

Query parameters

fromRecordintegerOptionalDefaults to 0

The zero-based index of the first record to return.

limitRecordintegerOptional<=200Defaults to 50

The maximum number of records to return (1 to 200).

sortBystringOptional

Sort expression, such as desc(createdAt) or asc(state). Defaults to desc(createdAt).

Response

A page of cases

summaryobject

Pagination and totals for a case list response.

recordslist of objects

The cases on this page. Each record is a full case object.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error