cronotaDocumentação da API

/customers

Por nome; q busca no nome, no e-mail e no documento.

Server URLhttps://cronota.clowk.in/api/v1
GET/customers

Autorização

Bearer token: sk_live_… (Live) ou sk_test_… (Sandbox). A chave define a empresa e o ambiente.

Parâmetros

qstring · queryopcional

Texto (busca no nome, no e-mail e no documento) ou filtros q[campo_predicado] em document_type, document, name, email, phone, created_at, updated_at, como q[name_start]=Ac.

sortstring · queryopcional

Um campo ou -campo. Padrão name.

pageinteger · queryopcional

A página, a partir de 1. A resposta diz total e has_more.

limitinteger · queryopcional

Itens por página, de 1 a 100.

Respostas

200A lista.
objectstringopcional
dataobject[]opcional
idstringopcional
Formato uuid
objectstringopcional
document_typestringopcional
Um de cnpj, cpf, nif, none
documentstringopcional
namestringopcional
emailstring | nullopcional
Formato email
phonestring | nullopcional
addressobjectopcional

No Brasil: zipcode, street, number, neighborhood, municipality_code (IBGE, 7 dígitos), city, state. No exterior: country, street, postal_code, city, region.

zipcodestringopcional
streetstringopcional
numberstringopcional
complementstringopcional
neighborhoodstringopcional
municipality_codestringopcional
citystringopcional
statestringopcional
countrystringopcional
postal_codestringopcional
regionstringopcional
created_atstringopcional
Formato date-time
updated_atstringopcional
Formato date-time
pageintegeropcional
limitintegeropcional
totalintegeropcional

Quantos itens os filtros acham, em todas as páginas.

has_morebooleanopcional

Há uma próxima página.