GEgem
Project Fields

List project fields

Returns a list of all project fields. Supports pagination and search parameters created_after, created_before.

get/v0/project_fields

Request

  • Base URL
    https://api.gem.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.gem.com/v0/project_fields
  • Auth
    none declared

Query parameters

created_afterinteger
created_beforeinteger
sort'asc' | 'desc'
is_hiddenboolean

Hidden project fields in projects are not displayed in the Gem product, nor are they returned when making a query on the Projects endpoint.

is_requiredboolean
namestring

The name of the project field.

field_type'text' | 'single_select' | 'multi_select'

Specifies the project field type. For text, the value is a string. For single_select, the value is a string representing a selected option. For multi_select, the value is an array of strings, each representing a selected option.

pageinteger
page_sizeinteger

Response

OK

idstring ObjectID
namestring required

The name of the project field.

field_type'text' | 'single_select' | 'multi_select' required

The type of the project field. Options are text, single_select, or multi_select.

user_idstring ObjectID required

The user id of the admin creating the project field.

is_requiredboolean
is_hiddenboolean

When is_hidden is true, project fields are not displayed in the Gem product, nor are they returned when making a query on the Projects endpoint.

Changes

No recorded changes to this operation across all 1 revision of this API.