Skip to main content
GET
/
clientes
Obter clientes
curl --request GET \
  --url https://api-vendas.taximachine.com.br/api/v2/integracao/clientes \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'api-key: <api-key>'
{
  "success": true,
  "data": [
    {
      "id": "1",
      "nome": "Exemplo",
      "email": "exemplo@email.com.br",
      "telefone": "(11) 97772-3133",
      "status_cliente": "A",
      "cpf": null
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

​
api-key
string
header
required

Obrigatório. Sua chave API.

Query Parameters

​
id
integer

ID do cliente de que se deseja saber informações, caso seja informado, os demais parâmetros serão ignorados. Caso não seja informado, retornará todos os clientes conforme os limites informados. O limite padrão é 20 e o máximo é 100.

​
status_cliente
enum<string>

Filtra os clientes pelo status:

A: Ativo I: Inativo S: Suspenso G: Aguardando ativação

Available options:
A,
I,
S,
G
​
limite
integer
default:20

Quantidade de clientes retornados. O limite padrão é 20 e o máximo é 100.

Required range: x <= 100
​
pagina
integer
default:1

Qual início da contagem para o limite. O padrão é 1.

Response

200 - application/json

Sucesso

The response is of type object.