List Cardholders

get

https://partner-api.getpliant.com/api/cardholders

🔒
Required scope: members:read
The API credential calling this endpoint must be granted the members category with read or read & write access.
Scopes are assigned to the credential when it is created or edited in Pliant, not requested when obtaining the access token.
A credential without this scope receives 403 Forbidden with the error code INSUFFICIENT_PERMISSION.

Returns a list of cardholders. You can use the limit, page, sortBy and sortDirection parameters to filter and sort the results.

Query Params

organizationId

uuid

required

The unique identifier of the organization.

status

string

enum

The status to filter by.

Allowed:

string

Filter by email address, case insensitive

fromDate

date-time

The from date to filter by as zero-offset UTC time. The date boundary is inclusive. Meaning we compare with >=.

toDate

date-time

The to date to filter by as zero-offset UTC time. The date boundary is inclusive. Meaning we compare with <=.

byDateField

string | null

enum

Defaults to registeredAt

The date field to filter by if fromDate and toDate are present.

Allowed:

limit

integer

The maximum number of items to return per page. The default value if not provided is 100, the maximum allowed value is 1000.

page

integer

The page number to return, starting with 0, this counts up to the total number of pages. The total number of pages is determined by the total number of records divided by the limit.

sortBy

string

enum

The field to sort by.

Allowed:

sortDirection

string

enum

The direction to sort by.

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200Ok

400Bad Request. The API consumer sent a malformed request which could not be processed.

401Unauthorized. The API consumer is not authorized to access the requested resource.

403Forbidden. The API consumer is not allowed to access the requested resource.

429Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our API guidelines.

500Internal Server Error. The request was not completed due to an internal error.