Skip to main content
GET
Get a field

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

id
string
required

The field ID.

Minimum string length: 1

Response

OK

id
string
required

The field ID.

Minimum string length: 1
name
string
required

Field name. Unique among the fields of one record type.

Required string length: 1 - 200
recordType
enum<string>
required

The kind of record the field belongs to.

Available options:
project,
account,
contact,
task
type
enum<string>
required

The field's value type. It can't be changed after the field is created.

Available options:
text,
long_text,
number,
boolean,
datetime,
email,
url,
address,
single_select,
collection,
user
options
string[]
required

Option labels of a single_select field, in order. Empty for other types.

automation
enum<string>
required

Whether Parley fills the field from emails and documents: off, suggest (proposes values for someone to accept), or auto (sets values directly).

Available options:
off,
suggest,
auto
automationInstructions
string | null
required

Guidance Parley follows when it fills the field, or null.

Required string length: 1 - 2000
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.