DOdovetail
Fields

List fields

Changed on

Get a list of fields for a project or workspace field group.

You must provide either project_id or workspace_field_group_id in the filter, along with field_set_type (data or doc).

Required scope: field:read

get/v1/fields

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/fields
  • Auth
    HTTP bearer

Query parameters

start_cursorstring
limitinteger nullable

See Pagination for details about how to use a cursor to iterate through the list.

'rank:asc' | 'rank:desc' | 'created_at:asc' | 'created_at:desc'
OR
string[]

See Sort for details on the sort parameter.

project_idstring

Unique identifier of the project.

workspace_field_group_idstring

Unique identifier of the workspace field group.

field_set_type'data' | 'doc' required

Filter by field set type: 'data' or 'doc'.

See Filters for details on parameter formatting.

Response

200

Changes

  • 8abea327e6b9Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status