---
title: "List fields (system + custom)"
method: GET
path: "/custom-fields"
tags: ["Custom Fields"]
---

# List fields (system + custom)

`GET /custom-fields`

## Request

- Base URL: `https://sending.dev/api/v1`
- URL: `https://sending.dev/api/v1/custom-fields`
- Auth: HTTP bearer

Required scope: `contacts:read` or `contacts:write`.

## Response `200`

Available fields.

- CustomFieldList
  - `data` CustomField[], required
    - `id` string, required
    - `key` string, required
    - `label` string, required
    - `type` string, required
    - `options` string[], nullable
    - `groupName` string, nullable
    - `isSystem` boolean
    - `archived` boolean

## Other responses

- `401`: Missing or invalid token.
- `403`: Insufficient scope.

---

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