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

# /contacts

`GET /contacts`

## Request

- Base URL: `<<api-url>>` (relative, and the document’s source URL is not known)
- URL: `<<api-url>>/contacts`
- Auth: API key in header `X-API-KEY`

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: This field refers to the organization to which the contact belongs
    - `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: Contact's responsible
    - `id` string: Id of the responsible
    - `name` string: Name of the responsible
    - `email` string: Email of the responsible

---

[API](https://skmtc.dev/octadesk/apis/octadesk-api.md) - [All operations](https://skmtc.dev/octadesk/apis/octadesk-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octadesk/apis/octadesk-api/revisions/cf3224b37a34?raw)
