Appearance
Find all customers
GET
/v1/api/customer
Authorizations
x-webhook-signature
Type
API Key (header: x-webhook-signature)
Parameters
Query Parameters
page
Page number to retrieve.If you provide invalid value the default page number will applied
Example: 1
Default Value: 1
Type
number
limit
Number of records per page.
Example: 20
Default Value: 20
Max Value: 100
If provided value is greater than max value, max value will be applied.
Type
number
sortBy
Parameter to sort by.
To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting
Format: fieldName:DIRECTION
Example: sortBy=id:DESC&sortBy=createdAt:ASC
Default Value: id:DESC
Available Fields
- id
Type
array
search
Search term to filter result values
Example: John
Default Value: No default value
Type
string
searchBy
List of fields to search by term to filter result values
Example: code
Default Value: By default all fields mentioned below will be used to search by term
Available Fields
- code
Type
array
Responses
application/json
JSON "data": [ { } ], "meta": "string", "links": { "first": "string", "previous": "string", "current": "string", "next": "string", "last": "string" }
{
}