Query Customers

Return a paginated list of matching customers.

SecurityMarketplace API Key | Merchant JWT | Marketplace JWT | Admin JWT
Request
query Parameters
limit
integer <int32>

Maximum results per page. Default to 20, must be between 1 and 500.

page
integer <int32>

Page number of results to show (starting at page 1).

sort
string

Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a - character.

createdAfter
string <date-time>

Return customers that were created at or after this timestamp

createdBefore
string <date-time>

Return customers that were created at or before this timestamp

emailAddress
Array of strings

Filter by email address

customerId
Array of strings

Filter by customer system identifier

merchantId
Array of strings

Filter by merchant system identifier

name
string

Filter by first name, last name or organisation name

Responses
200

Matching items sorted as specified

400
401
403
404
405
406
409
422
429
500
503
get/customers
Request samples 
Response samples 
application/json
[
  • {
    }
]
Copyright © April Solutions 2023. All right reserved.