Skip to main content
GET
/
v1
/
customer
/
paged
Listar clientes paginados.
curl --request GET \
  --url https://api.staging.cartaosimples.com.br/integration/v1/customer/paged \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "nome": "<string>",
      "documento": "<string>",
      "endereco": {
        "rua": "<string>",
        "cidade": "<string>",
        "estado": "<string>",
        "bairro": "<string>",
        "cep": "<string>",
        "pais": "<string>",
        "numero": "<string>",
        "complemento": "<string>"
      },
      "dataDeNascimento": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "celular": "<string>"
    }
  ],
  "page": {
    "hasNext": true,
    "hasPrevious": true,
    "number": 123,
    "size": 123,
    "total": 123,
    "maxPageNumber": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://documentacao.cartaosimples.com.br/llms.txt

Use this file to discover all available pages before exploring further.

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"

pagina
integer<int32>

Número da página. Padrão: 1.

Example:

1

tamanhoPagina
integer<int32>

Quantidade de itens por página. Padrão: 10.

Example:

10

Response

OK

items
object[] | null
read-only
page
object