# GET /api/custom-fields

> Custom Fields - List all Custom Field definitions

- **Endpoint:** `GET /api/custom-fields`
- **Group:** Custom Fields
- **Since:** v1.0.0
- **Defined in:** `RestApi/Controllers/CustomFieldsController.php`

## Headers

| Field | Type | Description |
| --- | --- | --- |
| `authtoken` | String | Authentication token, generated from admin area |

## Parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `related_to` | String | no | Optional context filter. One of: clients, client_contacts, companies, contracts, estimates, events, expenses, invoices, items, leads, lead_contacts, orders, projects, project_files, proposals, subscriptions, tasks, team_members, tickets, timesheets |

## Request example

```bash
curl -X GET "https://yoursite.com/index.php/api/custom-fields" \
  -H "authtoken: YOUR_API_TOKEN"
```

## Responses

### Success - Success-Response:

```json
HTTP/1.1 200 OK
[
  {
    "id": "3",
    "title": "Region",
    "title_language_key": "",
    "placeholder": "",
    "placeholder_language_key": "",
    "template_variable_name": "",
    "options": "North,South",
    "field_type": "select",
    "related_to": "clients",
    "sort": "1",
    "required": "0",
    "add_filter": "0",
    "show_in_table": "0",
    "show_in_invoice": "0",
    "show_in_estimate": "0",
    "show_in_contract": "0",
    "show_in_order": "0",
    "show_in_proposal": "0",
    "show_in_subscription": "0",
    "show_in_embedded_form": "0",
    "visible_to_admins_only": "0",
    "hide_from_clients": "0",
    "disable_editing_by_clients": "0",
    "show_on_kanban_card": "0",
    "deleted": "0"
  }
]
```

### Error - Error-Response:

```json
HTTP/1.1 404 Not Found
{ "status": false, "messages": { "error": "No data were found" } }
```

---

Part of the [REST API for RISE CRM](https://risecrm.themesic.com/apiguide/) documentation.
Full page: https://risecrm.themesic.com/apiguide/custom-fields/get-custom-fields/