API Reference

Listar empresas

Lista várias empresas 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": [ { "site": "https://site.com", "origin": 1, "life_cycle": 1, "source_id": 1, "source": { "id": 1, "name": "Instagram" }, "industry_id": 1, "industry": { "id": 1, "name": "Bazar" }, "parent_id": 1, "parent": { "id": 1, "name": "Nome do filial", "image": "https://image-url/image.png", "image_min": "https://image-url/image.png", "show_name": "Nome exibido da filial" }, "responsible_id": 1, "responsible": { "id": 1, "name": "Nome do responsável", "full_name": "Nome completo do responsável", "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 }, "creation_date": "2020-12-01T17:12:02Z", "update_date": "2022-06-02T17:37:55Z", "id": 1, "name": "Nome da companhia", "full_name": "Nome completo da companhia", "email": "email@atendare.com", "phone": "+55 999999999", "document": "294.515.040-95", "image": "https://image-url/image.png", "image_min": "https://image-url/image.png", "show_name": "Nome exibido da companhia", "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/095cf458-58e6-428a-b07e-40f48db9ff80.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_unidade_de_negocios": "Querência" } ] }
Query Params
int32
Defaults to 0

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

int32
Defaults to 15

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

string

Para fazer um filtro nos campos.

string

Define o campo que irá ordenar a lista.

string

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