Skip to main content
GET
List customers
Performance expectations:
p50: 450 ms, p99: 1200 ms.
Measured on successful requests (2xx), server-side only.
How to interpret these metrics

Authorizations

Authorization
string
header
required

Use OAuth2 client credentials to obtain a bearer token.

Token endpoint: POST <BASE_URL>/keycloak/realms/longship/protocol/openid-connect/token

Use the same base URL as the selected API server:

  • Test environment: https://apigwuat.corpay.com
  • Production environment: https://apigw.corpay.com

Example:

Query Parameters

limit
integer
default:50
cursor
string
customerAccountNumber
string

Limits the results to direct subaccounts of the specified customer account. If omitted, returns all descendants of the top-level account; the top-level account itself is never included.

searchText
string

Filters customers using a case-insensitive partial match against customerAccountNumber, customerName, or customerBusinessReference. When combined with customerAccountNumber, both filters are applied.

Response

Customers page

customers
object[]
hasNextPage
boolean
lastPage
boolean
nextCursor
string
totalCount
integer