> For the complete documentation index, see [llms.txt](https://docs.shortcutco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shortcutco.com/developers/api-reference/reference/objects/custom-field.md).

# The custom field object

The custom field object in the Shortcut API - every field, an example, and the endpoints that return it.

A custom field defined for customers in the workspace.

## Fields

| Field             | Type                                          | Description                                                                                                                                     |
| ----------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`              | id                                            | The field's id.                                                                                                                                 |
| `object`          | `"custom_field"`                              | Always `custom_field`.                                                                                                                          |
| `name`            | string                                        | The field's name as shown on the customer's profile.                                                                                            |
| `type`            | `text`, `select`, `date`, `number`, `boolean` | How values are written: `text` up to 200 characters, `select` an option id, `date` YYYY-MM-DD, `number` a decimal, `boolean` `true` or `false`. |
| `options`         | array of objects                              | A select field's options in display order; empty for other types.                                                                               |
| `options[].id`    | string                                        | The option's id, the value a select field stores.                                                                                               |
| `options[].label` | string                                        | The option's label.                                                                                                                             |

## Example

```json
{
  "id": "7fe3b2b1-7c2d-4df8-8878-293f74c26486",
  "object": "custom_field",
  "name": "Weekly mowing",
  "type": "text",
  "options": [
    {
      "id": "front_gate",
      "label": "Front gate"
    }
  ]
}
```

## Endpoints

| Endpoint                | What it does       |
| ----------------------- | ------------------ |
| `GET /v1/custom-fields` | List custom fields |