Customers

GET

https://api.data.v4.marketing/v1/tray/customers

Retrieve Tray customers with fiscal identifiers, addresses, and engagement metrics

Requisição

Authorization

API Key

Adicionar parâmetro em header

x-client-id

Exemplo:

x-client-id: ********************

API Key

Adicionar parâmetro em header

x-client-secret

Exemplo:

x-client-secret: ********************

Parâmetros de Consulta

Respostas

🟢200OK

application/json

Tray customers response

Body

🟠400Bad Request

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.data.v4.marketing/v1/tray/customers?workspaceId=workspace_123&organizationId&integrationId&page&limit&orderBy&orderDirection&createdStart&createdEnd&lastModifiedStart&lastModifiedEnd&registrationDateStart&registrationDateEnd&cnpj&id' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>'

Response Example

200 - Exemplo 1

{
    "data": [
        {
            "cnpj": "string",
            "newsletter": "string",
            "created": "2019-08-24T14:15:22.123Z",
            "terms": "2019-08-24T14:15:22.123Z",
            "id": "string",
            "name": "string",
            "registration_date": "2019-08-24T14:15:22.123Z",
            "rg": "string",
            "cpf": "string",
            "phone": "string",
            "cellphone": "string",
            "birth_date": "2019-08-24T14:15:22.123Z",
            "gender": "string",
            "email": "user@example.com",
            "nickname": "string",
            "token": "string",
            "total_orders": 0,
            "observation": "string",
            "type": "string",
            "is_foreign": "string",
            "company_name": "string",
            "state_inscription": "string",
            "reseller": true,
            "discount": 0,
            "blocked": "string",
            "credit_limit": 0,
            "indicator_id": "string",
            "profile_customer_id": "string",
            "last_sending_newsletter": "2019-08-24T14:15:22.123Z",
            "last_purchase": "2019-08-24T14:15:22.123Z",
            "last_visit": "2019-08-24T14:15:22.123Z",
            "last_modification": "2019-08-24T14:15:22.123Z",
            "address": "string",
            "zip_code": "string",
            "number": "string",
            "complement": "string",
            "neighborhood": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "modified": "2019-08-24T14:15:22.123Z",
            "count_orders": 0,
            "treated_phone": "string",
            "treated_cellphone": "string",
            "integration_id": "string",
            "workspace_id": "string",
            "organization_id": "string",
            "document_id": "string",
            "inserted_at": "2019-08-24T14:15:22.123Z"
        }
    ],
    "meta": {
        "page": 0,
        "limit": 0,
        "hasNextPage": true,
        "hasPreviousPage": true
    }
}

Modificado em 2025-12-01 14:44:51