API Reference

Listar contatos

Lista vários contatos de acordo com a ordem de criação.
Pode ser feito paginação pelo parâmetro da query {page_index} e {page_size}

Log in to see full request history
GET - 200 { "total": 1, "page_index": 0, "page_size": 15, "results": [ { "origin": 1, "life_cycle": 1, "gender": 1, "lead_scoring": 0.0, "jobtitle_id": 1, "jobtitle": { "id": 1, "name": "Desenvolvedor" }, "responsible_id": 1, "responsible": { "id": 1, "name": "Nome do responsável", "full_name": "Nome completo do responsável", "email": "email@atendare.com", "phone": "55 9 99999999", "document": "294.515.040-95", "image": "https://image-url/image.png", "image_min": "https://image-url/image.png", "show_name": "Nome exibido do responsável " }, "author_id": 1, "author": { "id": 1, "detail": "Nome do autor", "type": 1, "user_id": 1, "automation_id": 1, "form_id": 1, "import_id": 1, "user_uid": 1 }, "creation_date": "2020-12-18T13:03:47Z", "update_date": "2022-01-19T19:52:04Z", "company_id": 1, "company": { "id": 1, "name": "Nome da empresa", "image": "https://app.atendare.com/Account/Image/Index/No", "image_min": "https://app.atendare.com/Account/Image/Index/No/30", "show_name": "Nome exibido da empresa" }, "id": 1, "name": "Nome do contato", "full_name": "Nome completo do contato", "email": "email@atendare.com", "phone": "+55 999999999", "image": "https://app.atendare.com/Account/Image/Index/No", "image_min": "https://app.atendare.com/Account/Image/Index/No/30", "show_name": "Nome exibido do contato", "address": { "id": 1, "person_id": 1, "account_id": 1, "street": "Avenida Uruguai", "number": "513", "city": "Três de Maio", "state": "Rio Grande do Sul", "country": "Brasil", "postal_code": "98910-000", "complement": "Sala 201", "neighborhood": "Centro", "static_map": "https://atendare.storage.googleapis.com/0eae10f8-8302-4d2a-9e8f-a61ba6fd8f53/address/7a208942-0d71-4d8d-9594-9bcb3b0e444b.png", "is_main": true, "type": 3, "latitude": -27.779413, "longitude": -54.234719, "place_id": "ChIJqUhaByFS-ZQRQEhDuzWC2M8", "full_address": "Avenida Uruguai, 513 - Sala 201 - Centro, Três de Maio - Rio Grande do Sul - Brasil, 98910-000", "url_address": "Avenida+Uruguai%2C+513+-+Sala+201+-+Centro%2C+Tr%C3%AAs+de+Maio+-+Rio+Grande+do+Sul+-+Brasil%2C+98910-000" }, "custom_exemple": "custom value" // Campos personalizados sempre começam co om prefixo custom_ } ] }
Query Params
int32

Para paginação, representa o primeiro elemento da lista.

int32
Defaults to 15

Para paginação, define o total de contatos que ira ser retornado em uma lista. O limite é 100

string

Termo usado para pesquisar

string
Defaults to asc

Tipo de ordenação crescente (ASC) ou decrescente (DESC), o padrão é crescente

filter
object
Headers
string
required
Responses

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