v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Listar pessoas

Endpoint de lista de dados

get/persons

Query parameters

showinteger

Número de itens na página de resultado.

cursorstring

Hash da próxima página.

sortstring

Critérios de ordenação (ASC / DESC).

withstring

Obter recursos com relações. Opções: contactEmails, contactPhones

idinteger

Filtrar pelo ID da pessoa.

company_idinteger

Filtrar pelo ID do registro da empresa da pessoa.

city_idinteger

Filtrar pelo ID da cidade da pessoa.

manager_idinteger

Filtrar pelo ID do usuário CS responsável pela pessoa.

cpfstring

Filtrar pelo CPF da pessoa. Formatos aceitos: 123.456.789-01, 12345678901.

namestring

Filtrar pelo nome da pessoa.

job_titlestring

Filtrar pelo título do cargo da pessoa.

observationstring

Filtrar pelas observações do registro da pessoa.

customer_atstring date

Filtrar pela data em que a pessoa se tornou cliente.

external_codestring

Filtrar pelo código externo da pessoa.

statusboolean

Filtrar pelo status do registro da pessoa: 0: desativado, 1: ativado.

created_at_startstring date

Filtrar por registros de pessoas cadastradas a partir da data e hora informada.

created_at_endstring date

Filtrar por registros de pessoas cadastradas até a data e hora informada.

updated_at_startstring date

Filtrar por registros de pessoas atualizadas a partir da data e hora informada.

updated_at_endstring date

Filtrar por registros de pessoas atualizadas até a data e hora informada.

Response

200

successboolean

messagestring

Example response

{
  "success": true,
  "message": "OK",
  "data": [
    {
      "id": 748,
      "account_id": 748,
      "city_id": 748,
      "owner_id": 748,
      "manager_id": 748,
      "cpf": "708.901.040-69",
      "name": "Nome teste",
      "hash": "b14c52a2b2364e2f75ff696397a20890",
      "website": "CésarYagoFelipeAssis.com.br",
      "job_title": "Pedreiro",
      "gender": "Masculino",
      "birth_day": "1990-02-25",
      "observation": "Mora em Porto alegre",
      "customer_at": "2020-02-26",
      "facebook": "www.facebook.com.br/CésarYagoFelipeAssis",
      "linkedin": "www.linkedin.com.br/CésarYagoFelipeAssis",
      "address_postal_code": "97035-200",
      "address": "Avenida Circular",
      "address_number": "12",
      "address_complement": "quadra 2",
      "district": "Juscelino Kubitschek",
      "created_at": "2020-08-17 10:21:50",
      "status": 1,
      "city": {
        "id": 1,
        "uf": "RS",
        "name": "Santa Catarina"
      },
      "contact_emails": {
        "id": 748,
        "account_id": 748,
        "company_id": 748,
        "person_id": 748,
        "type": "Comercial",
        "email": "alex@santiago.com"
      },
      "contact_phones": {
        "id": 748,
        "account_id": 748,
        "company_id": 748,
        "person_id": 748,
        "type": "Comercial",
        "phone": "9999999999"
      }
    }
  ],
  "meta": {
    "cursor": {
      "next": "eyJpZCI6MjUyODM0LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"
    }
  }
}