---
title: "List fields"
method: GET
path: "/fields"
tags: ["Fields"]
---

# List fields

`GET /fields`

## Request

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

List the custom fields defined for projects, accounts, contacts, and tasks, newest first by default. Filter by record type, value type, name, and when fields were created or updated. Field values live on the records, in their fields, keyed by field name.

## Query parameters

- `search` string: Case-insensitive. Only fields whose name contains this text.
- `recordType` 'project' | 'account' | 'contact' | 'task': Only fields of this record type.
- `type` 'text' | 'long_text' | 'number' | 'boolean' | 'datetime' | 'email' | 'url' | 'address' | 'single_select' | 'collection' | 'user': Only fields of this value type.
- `createdSince` string: Only records created at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.
- `createdBefore` string: Only records created before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.
- `updatedSince` string: Only records last updated at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.
- `updatedBefore` string: Only records last updated before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.
- `sort` 'name' | '-name' | 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt': Sort order: a field name, prefixed with - for descending. Defaults to -createdAt.
- `cursor` string: Opaque cursor from nextCursor. Pass the same filters and sort. Omit for the first page.
- `limit` integer: Maximum number of items to return.

## Response `200`

OK

- object
  - `data` Field[], required
    - `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.
  - `nextCursor` string, nullable, required: Cursor for the next page, or null on the last page.

## Other responses

- `400`: The request was invalid. VALIDATION_FAILED, INVALID_CURSOR.
- `401`: Missing or invalid credentials. UNAUTHORIZED.
- `403`: You don't have permission. FORBIDDEN.
- `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)