---
title: "List Contact Fields"
method: GET
path: "/v1/contact/contact_fields"
tags: ["contact"]
---

# List Contact Fields

`GET /v1/contact/contact_fields`

## Request

- Base URL: `https://api.linktodm.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.linktodm.com/v1/contact/contact_fields`
- Auth: HTTP bearer

Paginated list of the user's custom User Field definitions.

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Successful Response

- PaginationSchemaContactFieldDefinitionResponse
  - `data` ContactFieldDefinitionResponse[], required
    - `id` integer, required
    - `name` string, required
    - `slug` string, required
    - `type` 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'BOOLEAN' | 'ARRAY', required: Data type of a custom contact User Field.
    - `description` string, nullable
    - `folder` string, nullable
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `total` integer, required
  - `limit` integer, required
  - `offset` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/linktodm/apis/salesmorph.md) - [All operations](https://skmtc.dev/linktodm/apis/salesmorph/llms.txt) - [OpenAPI document](https://skmtc.dev/linktodm/apis/salesmorph/revisions/4af0ad5dbe92?raw)