Retrieve a list of customers.
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 |
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). |
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). |
Rate-Limit-Limit | integer The number of allowed requests in the current period. |
Rate-Limit-Remaining | integer The number of remaining requests in the current period. |
Rate-Limit-Reset | string The date in format defined by RFC 822 when the current period will reset. |
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
id | string <= 50 characters The customer identifier string. |
websiteId | string <= 50 characters The website's ID. |
VaultedInstrument (object) or AlternativePaymentInstrument (object) or CashInstrument (object) or CheckInstrument (object) (PaymentInstrument) | |
createdTime | string <date-time> The customer created time. |
updatedTime | string <date-time> The customer updated time. |
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map |
object (ContactObject) | |
object (CustomerAverageValue) | |
paymentCount | integer The number of approved payments for the customer. |
lastPaymentTime | string <date-time> The most recent time of an approved payment for the customer. |
object (CustomerLifetimeRevenue) | |
invoiceCount | integer An auto-incrementing number based on the sequence of invoices. If set to 0, then this record is a Lead, otherwise is a Customer. |
Array of objects (Tag) A list of customer's tags. | |
revision | integer The number of times the customer data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation. |
Array of SelfLink (object) or DefaultPaymentInstrumentLink (object) or LeadSourceLink (object) or WebsiteLink (object) >= 3 items The links related to resource. | |
Array of LeadSourceEmbed (object) non-empty Any embedded objects available that are requested by the |
$customers = $client->customers()->search([ 'filter' => 'firstName:John', ]);
[- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "defaultPaymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "customFields": {
- "foo": "bar"
}, - "primaryAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": null,
- "address": "36 Craven St",
- "address2": "string",
- "city": "London",
- "region": "London",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
}, - "averageValue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "paymentCount": 0,
- "lastPaymentTime": "2019-08-24T14:15:22Z",
- "lifetimeRevenue": {
- "currency": "USD",
- "amount": 0,
- "amountUsd": 0
}, - "invoiceCount": 0,
- "tags": [
- {
- "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "name": "New",
- "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
], - "revision": 0,
- "_links": [
- {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}, - {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "leadSource": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "original": {
- "medium": "string",
- "source": "string",
- "campaign": "string",
- "term": "string",
- "content": "string",
- "affiliate": "string",
- "subAffiliate": "string",
- "salesAgent": "string",
- "clickId": "string",
- "path": "string",
- "referrer": "string",
- "createdTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "rel": "self",
- "href": null
}
]
}
}
}
]
}
]