List customers

get

https://test-api.payology.io/customer-vault/api/v1/customer

List customers using zero-based pagination. Use reference_id to search for an existing customer before retrying an uncertain creation request.

This request has no JSON body. Use the path/query examples below.

Request examples

ByReference

GET /customer-vault/api/v1/customer?reference_id=customer-1001&page=0&limit=25 HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json

Result codes in the response examples

HTTP status and result code are operation-specific. Field-validation messages can include the affected field name.

HTTP	Code	Result	Meaning
400	R0002	Error	Field is not properly formatted
401	R0003	Error	Authentication token is invalid
403	R0003	Error	Access not allowed
500	R0999	Error	Something went wrong

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 0

Defaults to 0

Zero-based page index.

limit

integer

0 to 64

Defaults to 12

Page size, default 12 and maximum 64. Use a positive value for pagination; the validator also accepts zero.

order

string

enum

Sort direction: asc or desc.

Allowed:

order_by

string

Defaults to first_name

Sort field. Default: first_name.

token

string

Customer UUID to retrieve/update, or filter in the customer list.

org_token

string

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Filter to the organization identified by this UUID.

reference_id

string

Partner-assigned reference used for reconciliation and supported reference lookups. Resource creation can enforce uniqueness within its scope.

company_name

string

Customer company name; can supply the company identity instead of an individual name pair.

first_name

string

Customer or cardholder given name.

last_name

string

Customer or cardholder family name.

city

string

Address city.

province

string

Address state/province code.

postal_code

string

Address postal/ZIP code; accepted format depends on the operation and country.

address

string

Street address, first line.

customer_type

string

enum

Customer classification: Billing, Shipping or Other.

Allowed:

string

Customer email address.

phone

string

Customer contact phone number.

Responses

default

Other infrastructure or forwarded downstream response. HTTP status and body must be preserved; do not assume every error has a Payology R-code. No fixed payload is guaranteed.

200Paginated customer list.

400Invalid fields, selector, or business rule. Consult the individual example code.

401Authentication failed. Some services also use 401 for organization access denial. Gateway bodies can differ.

403Permission or organization access denied; the gateway can reject the request before it reaches the service.

429Gateway throttling or quota. Exact quota, retry headers and deployed body were not verified. This is a platform possibility, not an observed Payology response.

500Unhandled service failure. Gateway configuration/authorizer failures can also return 500.

504Gateway integration timeout or failure. The service may still have committed a create request. This is a platform possibility, not an observed Payology response.