Tray Customers
GET
https://rest.api.mktlab.app/v1/tray/customers
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
cnpj | string | CNPJ da empresa (se aplicável). |
newsletter | string | Indica se o cliente está inscrito na newsletter (sim/não). |
created | Date | Data de criação do cliente na plataforma (formato ISO 8601). |
terms | Date | Data em que o cliente aceitou os termos de uso (formato ISO 8601). |
id | string | ID único do cliente na plataforma. |
name | string | Nome completo do cliente. |
registration_date | Date | Data de registro do cliente na plataforma (formato ISO 8601). |
rg | string | RG (Registro Geral) do cliente. |
cpf | string | CPF do cliente. |
phone | string | Número de telefone do cliente. |
cellphone | string | Número de celular do cliente. |
birth_date | Date | Data de nascimento do cliente (formato ISO 8601). |
gender | string | Gênero do cliente. |
email | string | E-mail do cliente. |
nickname | string | Apelido ou nome de usuário do cliente. |
token | string | Token de autenticação do cliente. |
total_orders | number | Número total de pedidos feitos pelo cliente. |
observation | string | Observações relacionadas ao cliente. |
type | string | Tipo do cliente (ex: "Pessoa Física", "Pessoa Jurídica"). |
is_foreign | string | Indica se o cliente é estrangeiro (sim/não). |
company_name | string | Nome da empresa do cliente, se for pessoa jurídica. |
state_inscription | string | Inscrição estadual da empresa, se for pessoa jurídica. |
reseller | boolean | Indica se o cliente é um revendedor (verdadeiro/falso). |
discount | number | Percentual de desconto aplicado ao cliente. |
blocked | string | Indica se o cliente está bloqueado (sim/não). |
credit_limit | number | Limite de crédito do cliente. |
indicator_id | string | ID do indicador relacionado ao cliente. |
profile_customer_id | string | ID do perfil do cliente. |
last_sending_newsletter | Date | Data do último envio de newsletter para o cliente (formato ISO 8601). |
last_purchase | Date | Data da última compra do cliente (formato ISO 8601). |
last_visit | Date | Data da última visita do cliente ao site (formato ISO 8601). |
last_modification | Date | Data da última modificação dos dados do cliente (formato ISO 8601). |
address | string | Endereço completo do cliente. |
zip_code | string | CEP do cliente. |
number | string | Número do endereço do cliente. |
complement | string | Complemento do endereço do cliente (se aplicável). |
neighborhood | string | Bairro onde o cliente reside. |
city | string | Cidade onde o cliente reside. |
state | string | Estado onde o cliente reside. |
country | string | País onde o cliente reside. |
modified | Date | Data da última modificação no cadastro do cliente (formato ISO 8601). |
count_orders | number | Número de pedidos realizados pelo cliente. |
treated_phone | string | Número de telefone tratado, com formatação. |
treated_cellphone | string | Número de celular tratado, com formatação. |
integration_id | string | ID da integração da plataforma com a conta do sistema Tray. |
project_id | string | ID do projeto associado ao cliente. |
unit_id | string | ID da unidade de negócios associada ao cliente. |
document_id | string | ID do documento relacionado ao cliente. |
inserted_at | Date | Data e hora em que o registro foi inserido no sistema (formato ISO 8601). |
Exemplo de JSON com os Resultados Esperados
Requisição
Parâmetros de Consulta
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://rest.api.mktlab.app/v1/tray/customers?registrationDateStart=2025-01-01®istrationDateStart=2025-01-31' \
--header 'Authorization: Bearer <token>'Response Response Example
{
"data": [
{
"columns": {
"cnpj": "12345678000195",
"newsletter": "sim",
"created": "2025-01-01T10:00:00Z",
"terms": "2025-01-01T10:00:00Z",
"id": "CLI123456",
"name": "João da Silva",
"registration_date": "2025-01-01T10:00:00Z",
"rg": "MG1234567",
"cpf": "12345678901",
"phone": "1234567890",
"cellphone": "9876543210",
"birth_date": "1985-05-15T00:00:00Z",
"gender": "Masculino",
"email": "joao.silva@example.com",
"nickname": "joaosilva",
"token": "abcd1234efgh5678",
"total_orders": 10,
"observation": "Cliente frequente",
"type": "Pessoa Física",
"is_foreign": "não",
"company_name": "João Silva Ltda",
"state_inscription": "123456789",
"reseller": true,
"discount": 10,
"blocked": "não",
"credit_limit": 500,
"indicator_id": "IND123",
"profile_customer_id": "PROFILE123",
"last_sending_newsletter": "2025-01-01T10:00:00Z",
"last_purchase": "2025-01-01T10:00:00Z",
"last_visit": "2025-01-01T10:00:00Z",
"last_modification": "2025-01-01T10:00:00Z",
"address": "Rua Exemplo, 123",
"zip_code": "12345678",
"number": "123",
"complement": "Apto 101",
"neighborhood": "Bairro Exemplo",
"city": "Cidade Exemplo",
"state": "MG",
"country": "Brasil",
"modified": "2025-01-01T10:00:00Z",
"count_orders": 5,
"treated_phone": "(12) 3456-7890",
"treated_cellphone": "(98) 7654-3210",
"integration_id": "INT123456",
"project_id": "PROJ123",
"unit_id": "UNIT001",
"document_id": "DOC12345",
"inserted_at": "2025-01-01T10:00:00Z"
}
}
],
"meta": {
"page": 1,
"limit": 500,
"total": 1,
"totalPages": 1,
"hasNextPage": false,
"hasPreviousPage": true
}
}Modificado em 2025-10-08 17:25:55