PAparley
Fields

List fields

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.

get/fields

Request

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

Query parameters

searchstring

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.

createdSincestring

Only records created at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

createdBeforestring

Only records created before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

updatedSincestring

Only records last updated at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

updatedBeforestring

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.

cursorstring

Opaque cursor from nextCursor. Pass the same filters and sort. Omit for the first page.

limitinteger

Maximum number of items to return.

Response

OK

nextCursorstring nullable required

Cursor for the next page, or null on the last page.

Changes

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