---
title: "List custom fields"
description: "Returns every custom field (CRM column) in the workspace, with the ids you need for **Create or update a contact**."
---

> Documentation Index
> Fetch the complete documentation index at: https://zacx.io/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Zacx Public API › Custom Fields

`GET /customFields`

Returns every custom field (CRM column) in the workspace, with the ids you need for **Create or update a contact**.

## Authentication

- `bearerAuth`, http, header `Authorization`

## Code samples

### cURL

```curl
curl --request GET \
  --url https://api.zacx.io/v1/customFields \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.zacx.io/v1/customFields';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.zacx.io/v1/customFields"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

The custom fields. `data` is empty when none are configured.

#### Example

```json
{
  "status": "success",
  "data": [
    {
      "id": "c79996c1-af9f-4353-810f-153417ec34cf",
      "name": "test field",
      "type": "single_line"
    }
  ]
}
```

- `listCustomFields.response.200.status` (string, required)
- `listCustomFields.response.200.data` (array<object>, required)
  - `listCustomFields.response.200.data.id` (string, required)
    - format `uuid`
  - `listCustomFields.response.200.data.name` (string, required)
    - example `"test field"`
  - `listCustomFields.response.200.data.type` (string, required) — Field type as configured in the CRM.
    - example `"single_line"`
- `listCustomFields.response.200.message` (string, optional) — Present only when the workspace has no custom fields.


Source: https://zacx.io/api/custom-fields/list/index.md