---
title: "Get a field"
method: GET
path: "/fields/{id}"
tags: ["Fields"]
---

# Get a field

`GET /fields/{id}`

## Request

- Base URL: `https://api.parley.so/v1`
- URL: `https://api.parley.so/v1/fields/{id}`
- Auth: HTTP bearer

Get a single custom field definition by ID.

## Path parameters

- `id` string, required: The field ID.

## Response `200`

OK

- Field
  - `id` string, required: The field ID.
  - `name` string, required: Field name. Unique among the fields of one record type.
  - `recordType` 'project' | 'account' | 'contact' | 'task', required: The kind of record the field belongs to.
  - `type` 'text' | 'long_text' | 'number' | 'boolean' | 'datetime' | 'email' | 'url' | 'address' | 'single_select' | 'collection' | 'user', required: The field's value type. It can't be changed after the field is created.
  - `options` string[], required: Option labels of a single_select field, in order. Empty for other types.
  - `automation` 'off' | 'suggest' | 'auto', required: Whether Parley fills the field from emails and documents: off, suggest (proposes values for someone to accept), or auto (sets values directly).
  - `automationInstructions` string, nullable, required: Guidance Parley follows when it fills the field.
  - `system` boolean, required: A built-in field. It can't be renamed, reconfigured, or deleted, but its values can be set like any other field's.
  - `readOnly` boolean, required: Parley maintains the field's values, so they can't be set through fields on a record.
  - `createdAt` string, date-time, required: When the field was created.
  - `updatedAt` string, date-time, required: When the field definition was last updated. Setting values on records does not change it.

## Other responses

- `400`: The request was invalid. VALIDATION_FAILED.
- `401`: Missing or invalid credentials. UNAUTHORIZED.
- `403`: You don't have permission. FORBIDDEN.
- `404`: Not found. NOT_FOUND.
- `429`: Too many requests, or a usage limit was reached. TOO_MANY_REQUESTS.

---

[API](https://skmtc.dev/parley/apis/parley-api.md) - [All operations](https://skmtc.dev/parley/apis/parley-api/llms.txt) - [OpenAPI document](https://skmtc.dev/parley/apis/parley-api/revisions/6b78aeee07bc?raw)