API Reference
Client PortalAPI StatusWebsite

Get Cases

get
https://www.bankingcircleconnect.com/api/v1/cases

This endpoint is used for retrieving a paginated list of Cases.
You start by sending an initial request with the desired parameters set (Type, Status, Limit, Order).
The response will include metadata such as number of records returned and if there are more records in the direction requested.
The response will include a 'Links' object with 'Next' and 'Previous' links that must be used to get the next or previous page.
If response states there are no more records after using a 'Next-link' you are at the end for now.
The response will still contain a 'Next-link' that may result in more records in the future, depending on sort order.

Query Params
string

Type of cases to retrieve. Possible values:

  • 'RFI'

  • 'RECALL'

string

Status of cases to retrieve. Possible values:

  • 'OPEN'

  • 'IN_PROGRESS'

  • 'CLOSED'

If not provided, no status filtering is applied.

string

Filter cases created on or after this date (inclusive).

Format: yyyy-MM-dd.

string

Filter cases created on or before this date (inclusive).

Format: yyyy-MM-dd.

int32

Max number of records to return per page.

Must be bigger than 0 and less than or equal to 1000. Default is 100.

Cannot be used together with Cursor.

string

Order of the records returned. Possible values:

  • 'DESC' (Default)

  • 'ASC'

Cannot be used together with Cursor.

string

A cursor used to fetch the next or previous page of results.

Cannot be used with any other parameters except Direction.

string

The direction of traversal when using Cursor. Possible values:

  • 'NEXT'

  • 'PREV'

Required when using Cursor.

Responses

Updated 4 months ago

Language
Credentials
Bearer
Response 
 Choose an example:
application/json
Updated 4 months ago