List Customers

Sortable list of all customers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Sorting

The following fields can be sorted using the sortby query string parameter:

FirstName LastName Company BillingAddress.City BillingAddress.State BillingAddress.Zip
BillingAddress.Country ShippingAddress.City ShippingAddress.State ShippingAddress.Zip ShippingAddress.Country

If sortby is omitted, by default customers are returned sorted by creation date, with the most recently created customers appearing first.

Lite Response Format

If the lite query string parameter is set to true, the response will contain only the following basic customer information fields:
FirstName LastName Email Company Phone Id

This format is useful when returning large lists and in applications such as mobile where bandwidth is at a premium.

Number of Items

The PagingDetails.TotalItems property returns the total number of items to be returned.

Query Params
string
Defaults to Id

Optional. Field name to sort by. See below for valid sort fields.

string
Defaults to desc

Optional. Valid values: asc: Ascending, sort low-to-high / A-to-Z. nulls appear first. desc: Descending, sort high-to low / Z-to-A nulls appear last.

int32
Defaults to 1

Optional. The page number of the result set to be returned.

int32
Defaults to 200

Optional. The number of results to be returned. Defaulted to 200 if value is not provided.

boolean
Defaults to false

Optional. When set to true only a small subset of fields will be returned in the response.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
LoadingLoading…
Response
Choose an example:
application/json
text/plain