PAparley
Fields

Get a field

Get a single custom field definition by ID.

get/fields/{id}

Request

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

Path parameters

idstring required

The field ID.

Response

OK

idstring required

The field ID.

namestring 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.

optionsstring[] 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).

automationInstructionsstring nullable required

Guidance Parley follows when it fills the field.

systemboolean required

A built-in field. It can't be renamed, reconfigured, or deleted, but its values can be set like any other field's.

readOnlyboolean required

Parley maintains the field's values, so they can't be set through fields on a record.

createdAtstring date-time required

When the field was created.

updatedAtstring date-time required

When the field definition was last updated. Setting values on records does not change it.

Changes

No recorded changes to this operation across all 2 revisions of this API.