Skip to content
Partners API/
/
List all customers

List all customers

Request

Return a list of customers. For single-merchant partners, this returns customers belonging to your sub-merchants. For marketplace partners, this returns customers belonging to your marketplace.

Security
bearerAuth or basicAuth
Query
limitinteger, [ 25 .. 100 ]

Limit the number of customers returned.

Default:25
pagestring

Specify the page of customers returned.

Default:"1"
filterobject

Filter customers by the specified fields.

Filter semantics: filter[field][operator]=value.

Available filter operators:

  • eq - equal (=)
  • ne - not equal (!=)
  • gt - greater than (>)
  • gte - greater than or equal (>=)
  • lt - less than (<)
  • lte - less than or equal (<=)

Filtering is allowed by the following fields:

  • merchant_id (eq) — only available for single-merchant partners
  • external_id (eq)
  • email (eq)
  • business_name (eq)
  • created_at (eq, gt, lt, gte, lte)
  • amount_approved (eq, gt, lt, gte, lte)
  • amount_available (eq, gt, lt, gte, lte)
  • amount_authorized (eq, gt, lt, gte, lte)
  • amount_balance (eq, gt, lt, gte, lte)
  • amount_unapplied_payments (eq, gt, lt, gte, lte)
  • advance_rate (eq, gt, lt, gte, lte)
  • archived (eq, ne)

Example: filter[email][eq]=test@resolvepay.com Example: filter[external_id][eq]=CUS-123456

Note: filter with the eq operator is equivalent to the following filter filter[field]=value

sortstring

Sort customers by the specified fields.

The sort order for each sort field is ascending unless it is prefixed with a minus, in which case it is descending.

Multiple sort fields supported by allowing comma-separated sort fields. Sort fields will be applied in the order specified.

Sorting is allowed by the following fields: id, created_at, amount_approved, amount_available, business_name.

Example: sort=business_name,-created_at

curl -i -X GET \
  'https://docs.resolvepay.com/_mock/partners-api/openapi/customers?limit=25&page=1&filter=%7B%22merchant_id%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22external_id%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22email%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22business_name%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22created_at%22%3A%7B%22eq%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22gt%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22lt%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22gte%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22lte%22%3A%222019-08-24T14%3A15%3A22Z%22%7D%2C%22amount_approved%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_available%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_authorized%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_balance%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_unapplied_payments%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22advance_rate%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22archived%22%3A%7B%22eq%22%3Atrue%2C%22ne%22%3Atrue%7D%7D&sort=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

An object with an array of results containing up to the limit. If no customers are found, the results array will be empty.

Bodyapplication/json
countinteger
Example:1
limitinteger
Example:25
pageinteger
Example:1
resultsArray of objects(Customer)
Response
{
  "count": 1,
  "limit": 25,
  "page": 1,
  "results": [
    { … }
  ]
}