List Cardholders
Changed onReturns a list of cardholders. You can use the limit, page, sortBy and sortDirection parameters to filter and sort the results.
Request
- Base URLhttps://partner-api.getpliant.com/api
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The unique identifier of the organization.
The status to filter by.
Filter by email address, case insensitive
The from date to filter by as zero-offset UTC time. The date boundary is inclusive. Meaning we compare with >=.
The to date to filter by as zero-offset UTC time. The date boundary is inclusive. Meaning we compare with <=.
The date field to filter by if fromDate and toDate are present.
The maximum number of items to return per page. The default value if not provided is 100, the maximum allowed value is 1000.
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.
The field to sort by.
The direction to sort by.
Response
Ok
Changes
- breaking
the response's body type changed from no type to
objectfor status - breaking
the response's body type changed from no type to
objectfor status - breaking
the response's body type changed from no type to
objectfor status - breaking
the response's body type changed from no type to
objectfor status - warning
added the new
CANCELLEDenum value to the///response property for the response status - info
added the new enum value
CANCELLEDto thequeryrequest parameterstatus - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- breaking