v1

latestOpenAPI 3.0.22026-07-261040577.4 KB
Fields

List fields

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

get/v1/fields

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