v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

GET All Customers

Com este endpoint, você pode listar todos os clientes cadastrados no sistema.

É possível filtrar os resultados utilizando os query params disponíveis listados abaixo.

get/api/customers

Query parameters

idinteger

Id do seu cliente adicionado na plataforma.

namestring

Primeiro nome do cliente adicionado na plataforma.

last_namestring

Sobrenome do cliente adicionado na plataforma.

emailstring

Endereço de e-mail do cliente adicionado na plataforma.

phoneinteger

Número de telefone do cliente adicionado na plataforma.

addressstring

Endereço do seu cliente adicionado na plataforma.

Response

200

Example response

{
  "data": [
    {
      "id": 1,
      "name": "João",
      "last_name": "Silva",
      "phone": "11-99999-9999",
      "email": "developer@exemplo.com",
      "recive_email": 1,
      "recive_whatsapp": 1
    }
  ]
}