Skip to main content
GET
/
v1
/
customer
/
list
Listar clientes.
curl --request GET \
  --url https://api.staging.cartaosimples.com.br/integration/v1/customer/list \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "nome": "Maria Souza",
    "documento": "98765432100",
    "endereco": {
      "rua": "Av. Paulista",
      "cidade": "São Paulo",
      "estado": "SP",
      "bairro": "Bela Vista",
      "cep": "01310-100",
      "pais": "BR",
      "numero": "1578",
      "complemento": "Apto 42"
    },
    "dataDeNascimento": "1990-03-22T00:00:00Z",
    "email": "maria.souza@email.com",
    "celular": "+55 (11) 91234-5678"
  }
]

Authorizations

​
Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <token> onde <token> é seu TOKEN de autenticação

Query Parameters

​
nome
string

Filtrar por nome do cliente. Campo opcional.

Example:

"Maria Souza"

​
documento
string

Filtrar por CPF do cliente (somente números). Campo opcional.

Example:

"12345678901"

Response

OK

​
id
string<uuid>
​
nome
string
​
documento
string
​
endereco
object
​
dataDeNascimento
string<date-time>
​
email
string | null
​
celular
string | null