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

# /contacts

`GET /contacts`

Get all contacts or filter using search criteria

## Query parameters

- `filters` Filters[]
  - `property` string, required — Name of the property
  - `operator` 'eq' | 'ne' | 'lt' | 'gt' | 'le' | 'ge' | 'in' | 'nin', required — Comparison operator
  - `value` union, required — Name of the property
    - string
    - number
    - boolean
- `page` number
- `limit` number
- `sort` Sort
  - `property` string, required — Name of the property to sort
  - `direction` 'asc' | 'desc', required — 'asc' or 'desc' to order the result

## Headers

- `octa-agent-email` string

## Response `201`

- ContactsPayload[]
  - `id` string — Customer ID
  - `name` string — Customer name
  - `email` string — Customer email
  - `phoneContacts` PhoneContacts[] — Phone info that will receive the message
    - `number` string, required — Phone Number that will receive the message
    - `countryCode` string — Country code
  - `customFields` CustomFields[] — Fields to be used on the template (key / value)
    - `key` string, required — Key of the field
    - `value` union, required — Value of the field
      - string
      - number
      - boolean
  - `organization` Organization
    - `id` string, required — Organization ID
    - `name` string, required — Organization name
    - `customField` CustomFields[], required — Organization custom fields
      - `key` string, required — Key of the field
      - `value` union, required — Value of the field
        - string
        - number
        - boolean
  - `responsible` ResponsibleDTO
    - `id` string — Id of the responsible
    - `name` string — Name of the responsible
    - `email` string — Email of the responsible

---

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