Tray

Customers

GET
/v1/tray/customers

Retrieve Tray customer commerce, engagement, and lifecycle metrics

Authorization

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Query Parameters

organizationId*string

Organization identifier (required)

integrationId?string

Tray integration identifier

integrationName?string

Tray integration name

page?integer

Page number (default 1)

Default1
limit?integer

Items per page (default 500, max 5000)

Rangevalue <= 5000
Default500
id?string

Filter by customer ID

registrationDateStart?string

Filter by registration date start

Formatdate-time
registrationDateEnd?string

Filter by registration date end

Formatdate-time
createdStart?string

Filter by creation date start

Formatdate-time
createdEnd?string

Filter by creation date end

Formatdate-time
lastModifiedStart?string

Filter by last modification start

Formatdate-time
lastModifiedEnd?string

Filter by last modification end

Formatdate-time

Response Body

Tray customers response

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/tray/customers?organizationId=org_123"
{  "data": [    {      "newsletter": "string",      "created": "2019-08-24T14:15:22Z",      "terms": "2019-08-24T14:15:22Z",      "id": "string",      "registration_date": "2019-08-24T14:15:22Z",      "email": "user@example.com",      "total_orders": 0,      "type": "string",      "is_foreign": "string",      "reseller": true,      "discount": 0.1,      "blocked": "string",      "credit_limit": 0.1,      "indicator_id": "string",      "profile_customer_id": "string",      "last_sending_newsletter": "2019-08-24T14:15:22Z",      "last_purchase": "2019-08-24T14:15:22Z",      "last_visit": "2019-08-24T14:15:22Z",      "last_modification": "2019-08-24T14:15:22Z",      "modified": "2019-08-24T14:15:22Z",      "count_orders": 0,      "integration_id": "string",      "organization_id": "string",      "document_id": "string",      "integration_name": "string",      "inserted_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}