Try it

Retrieve a list of customers

Retrieve a list of customers.

Authorizations:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit

offset
integer >= 0

The collection items offset

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

q
string

The partial search of the text fields.

expand
string

Expand a response to get a full related object included inside of the _embedded path in the response.

It accepts a comma-separated list of objects to expand.

See the expand guide for more info.

fields
string

Limit the returned fields to the list specified, separated by comma. Note that id is always returned.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used)

Responses

Request samples

$customers = $client->customers()->search([
    'filter' => 'firstName:John',
]);

Response samples

Content type
application/json
[
  • {
    }
]