v1

latestOpenAPI 3.1.02026-07-24270180.3 KB

Query a customer

Search for all or a specific customer

get/v1/customers/{id}

Path parameters

idstring required

The customer ID returned at the creation stage. Omitting this will return a list of all customers.

Query parameters

limitstring

Pagination parameter to limit output to n , default = 100 , maximum value = 1000

skipstring

Pagination parameter to skip first n customers from list, default = 0

sortkeystring

Sorting key parameter i.e. created_at

sortdirectionstring

Sorting order direction parameter ASC or DESC (DESC by default)

gateway_idstring

ID of a gateway with which charges were created

payment_source_idstring

ID of a stored customers payment_source

statusstring
archivedboolean

Set to true to show all the archived charges.

referencestring

The manually defined reference from the creation stage.

company_namestring

The company name defined in the customer creation stage

searchstring

Word or phrase you want to search on your customers.

Headers

x-user-secret-keystring required

Your API private/secret key. This can be found in the powerboard dashboard.

Content-Typestring required

Content-Type will always be application/json

Response

200

object required