---
title: "Listar"
method: GET
path: "/v1/contact"
tags: ["Contatos"]
---

# Listar

`GET /v1/contact`

Listagem paginada de contatos. Para resultados mais específicos, utilize o endpoint `/filter`.

## Query parameters

- `IncludeDetails` string[]
- `Status` 'ACTIVE' | 'ARCHIVED' | 'BLOCKED'
- `CreatedAt.Before` string, date-time
- `CreatedAt.After` string, date-time
- `UpdatedAt.Before` string, date-time
- `UpdatedAt.After` string, date-time
- `PageNumber` integer
- `PageSize` integer
- `OrderBy` string
- `OrderDirection` 'ASCENDING' | 'DESCENDING'

## Response `200`

Success

- PublicContactDTOPublicPageListDTO
  - `pageNumber` integer — Número da página a ser obtida.
  - `pageSize` integer — Tamanho da página a ser obtida.
  - `orderBy` string, nullable — Nome do campo para ser utilizado como pivô da ordenação.
  - `orderDirection` 'ASCENDING' | 'DESCENDING', nullable — Determina se a ordenação deve ser crescente ou decrescente.
  - `items` PublicContactDTO[], nullable
    - `id` string, uuid
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `companyId` string, uuid
    - `name` string, nullable
    - `nameWhatsapp` string, nullable
    - `nameInstagram` string, nullable
    - `nameMessenger` string, nullable
    - `phoneNumber` string, nullable
    - `phoneNumberFormatted` string, nullable
    - `email` string, nullable
    - `instagram` string, nullable
    - `messengerId` string, nullable
    - `annotation` string, nullable
    - `tagIds` string[], nullable
    - `tagNames` string[], nullable
    - `status` 'ACTIVE' | 'ARCHIVED' | 'BLOCKED'
    - `origin` 'CREATED_BY_USER' | 'CREATED_FROM_HUB' | 'IMPORTED'
    - `importedAt` string, date-time, nullable
    - `utm` PublicUtmDTO
      - `sourceId` string, nullable
      - `source` string, nullable
      - `clid` string, nullable
      - `medium` string, nullable
      - `campaign` string, nullable
      - `content` string, nullable
      - `headline` string, nullable
      - `term` string, nullable
      - `referralUrl` string, nullable
    - `customFields` object, nullable
    - `portfolioIds` string[], nullable
    - `portfolioNames` string[], nullable
    - `metadata` object, nullable
  - `totalItems` integer
  - `totalPages` integer
  - `hasMorePages` boolean

## Other responses

- `500` — Server Error

---

[API](https://skmtc.net/helena/apis/core.md) · [All operations](https://skmtc.net/helena/apis/core/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helena/core/revisions/811b2cdd2ec2/schema)