---
title: "Listar pessoas"
method: GET
path: "/persons"
---

# Listar pessoas

`GET /persons`

Endpoint de lista de dados

## Query parameters

- `show` integer
- `cursor` string
- `sort` string
- `with` string
- `id` integer
- `company_id` integer
- `city_id` integer
- `manager_id` integer
- `cpf` string
- `name` string
- `job_title` string
- `observation` string
- `customer_at` string, date
- `external_code` string
- `status` boolean
- `created_at_start` string, date
- `created_at_end` string, date
- `updated_at_start` string, date
- `updated_at_end` string, date

## Response `200`

200

- object
  - `success` boolean
  - `message` string
  - `data` object[]
    - `id` integer
    - `account_id` integer
    - `city_id` integer
    - `owner_id` integer
    - `manager_id` integer
    - `cpf` string
    - `avatar` string
    - `name` string
    - `hash` string
    - `website` string
    - `job_title` string
    - `gender` string
    - `birth_day` string
    - `observation` string
    - `customer_at` string
    - `facebook` string
    - `linkedin` string
    - `address_postal_code` string
    - `address` string
    - `address_number` string
    - `address_complement` string
    - `district` string
    - `created_at` string
    - `lat` string
    - `lng` string
    - `external_code` string
    - `status` integer
    - `foreign_contact` integer
    - `city` object
      - `id` integer
      - `uf` string
      - `name` string
    - `contact_emails` object
      - `id` integer
      - `account_id` integer
      - `company_id` integer
      - `person_id` integer
      - `type` string
      - `email` string
      - `is_main` integer
    - `contact_phones` object
      - `id` integer
      - `account_id` integer
      - `company_id` integer
      - `person_id` integer
      - `type` string
      - `phone` string
      - `is_main` integer
    - `custom_fields` object
  - `meta` object
    - `cursor` object
      - `current` unknown
      - `prev` unknown
      - `next` string
      - `count` unknown

## Other responses

- `404` — 404

---

[API](https://skmtc.net/pipe/apis/application-json.md) · [All operations](https://skmtc.net/pipe/apis/application-json/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pipe/application-json/versions/0a130198f0a3/schema)