Listar Clientes

get

https://api.iugu.com/v1/customers

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.

Query Params

limit

int32

Limita o número de registros retornados em até 100, que é o padrão de retorno desta chamada. Também utilizado em paginação.

start

int32

Quantos registros pular do início da pesquisa.

created_at_from

date

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

created_at_to

date

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

query

string

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_since

date

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

updated_until

date

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

Responses

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400