/customers
Por nome; q busca no nome, no e-mail e no documento.
Server URL
https://cronota.clowk.in/api/v1GET
/customersAutorização
Bearer token: sk_live_… (Live) ou sk_test_… (Sandbox). A chave define a empresa e o ambiente.
Parâmetros
qstring · queryopcionalTexto (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 · queryopcionalUm campo ou -campo. Padrão name.
pageinteger · queryopcionalA página, a partir de 1. A resposta diz total e has_more.
limitinteger · queryopcionalItens por página, de 1 a 100.
Respostas
200A lista.
objectstringopcionaldataobject[]opcionalidstringopcionalFormato uuid
objectstringopcionaldocument_typestringopcionalUm de cnpj, cpf, nif, none
documentstringopcionalnamestringopcionalemailstring | nullopcionalFormato email
phonestring | nullopcionaladdressobjectopcionalNo Brasil: zipcode, street, number, neighborhood, municipality_code (IBGE, 7 dígitos), city, state. No exterior: country, street, postal_code, city, region.
zipcodestringopcionalstreetstringopcionalnumberstringopcionalcomplementstringopcionalneighborhoodstringopcionalmunicipality_codestringopcionalcitystringopcionalstatestringopcionalcountrystringopcionalpostal_codestringopcionalregionstringopcionalcreated_atstringopcionalFormato date-time
updated_atstringopcionalFormato date-time
pageintegeropcionallimitintegeropcionaltotalintegeropcionalQuantos itens os filtros acham, em todas as páginas.
has_morebooleanopcionalHá uma próxima página.