v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Listar Clientes

Retorna uma lista com os clientes cadastrados em sua conta, ordenados pela data de criação, do mais recente para o mais antigo. O campo totalItems indica a quantidade de registros retornados nesta página (igual ao tamanho de items ). Para detectar o fim da listagem, compare items.length com limit : se for menor, não há mais páginas.

get/customers

Query parameters

limitinteger

Limita o número de registros retornados em até 100, que é o padrão de retorno desta chamada. Também utilizado em <a href="https://dev.iugu.com/v1.0/reference#paginação">paginação</a>.

startinteger

Quantos registros pular do início da pesquisa.

created_at_fromstring date

Registros criados a partir desta data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

created_at_tostring date

Registros criados até esta data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

querystring

Neste parâmetro pode ser passado um texto para pesquisa como e-mail, nome, anotações e variáveis customizadas. Ao usar este parâmetro, necessário usar paginação (limit, start, etc).

updated_sincestring date

Registros atualizados desde o valor passado no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

updated_untilstring date

Retorna apenas registros atualizados até a data/hora informada. Formato (AAAA-MM-DDThh:mm:ss-03:00)

Response

200

totalItemsinteger

Example response

{
  "items": [
    {
      "id": "6A7BE09792BA40CFB13AA504367E5E12",
      "email": "email@iugu.com",
      "name": "Nome do Cliente",
      "notes": "Nota  sobre este cliente",
      "created_at": "2025-04-03T12:04:38-03:00",
      "updated_at": "2025-04-03T12:07:31-03:00",
      "cpf_cnpj": "11343675030",
      "zip_code": "13056-344",
      "number": "60",
      "complement": "APTO 1702",
      "phone": "972312345",
      "phone_prefix": "11",
      "custom_variables": [
        {
          "name": "My-var",
          "value": "var"
        }
      ],
      "city": "Campinas",
      "state": "SP",
      "district": "Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)",
      "street": "Rua Antônio Nunes"
    }
  ],
  "totalItems": 57
}