v1

latestOpenAPI 3.1.0Apache 2.02026-07-2473175248.0 KB

1. Customers

Get a list of all Customers on this Platform.

get/customers

displayNamestring

Specify the customer display name to be queried.

statusstring

Specify the status to be queried.

customerMinDateCreatedAtstring date-time

Specify the customer earliest createdAt date to be queried.

customerMaxDateCreatedAtstring date-time

Specify the customer latest createdAt date to be queried.

accountStatusstring

Specify the account status to be queried.

accountIdentifierstring

Specify the account identifier to be queried.

accountNumberstring

Specify the account number to be queried.

accountDisplayNamestring

Specify the account display name to be queried.

accountMinDateCreatedAtstring date-time

Specify the earliest createdAt date to be queried.

accountMaxDateCreatedAtstring date-time

Specify the latest createdAt date to be queried.

paginateboolean

Whether to paginate the results or not. Defaults to false.

prevCursorstring

The cursor to use for the previous page of results. This will be ignored if paginate is false.

nextCursorstring

The cursor to use for the next page of results. This will be ignored if paginate is false.

maxResultsinteger

The maximum number of results to return. The default is 10, and the maximum is 200. This will be ignored if paginate is false.

customerIdentifierstring required

displayNamestring required

statusstring required

createdAtstring required

All 73 operations