---
title: "List Contacts"
method: GET
path: "/v3/contacts"
tags: ["Contatos"]
---

# List Contacts

`GET /v3/contacts`

Listar os contatos paginado

## Query parameters

- `newContact` boolean, required

## Response `200`

- object
  - `totalCount` number — Total de registros
  - `data` Contact[]
    - `id` string, required
    - `_id` string, required
    - `name` string — The contact’s full name or business name
    - `email` string — The contact’s email address
    - `externalId` string, required
    - `origin` string, required
    - `phone` string — The contact’s phone number
    - `location` string, required
    - `avatar` string — Url of the contact image
    - `facebookId` string, required
    - `instagramId` string, required
    - `telegramId` string, required
    - `notes` string — The contact’s notes
    - `isImported` boolean, required
    - `hasConversation` boolean, required
    - `newContact` boolean, required
    - `customFields` object, required
    - `crmData` object, required
      - `utmCampaigns` object
      - `referrals` object
        - `_bg` string
        - `_bt` string
        - `gclid` string
        - `offer` string
        - `utm_ad` string
        - `utm_term` string
        - `source_id` string
        - `gad_source` string
        - `media_type` string
        - `source_url` string
        - `utm_medium` string
        - `utm_source` string
        - `source_type` string
        - `utm_ad_name` string
        - `utm_campaign` string
        - `utm_ad_collection` string
        - `utm_campaign_name` string
        - `utm_ad_collection_name` string
      - `hubspotId` string
      - `zohoId` string
      - `zohoType` string
      - `cloud_api` object
    - `isPrivate` boolean — Private contacts can only be seen by users who have the permission to view private contacts

---

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