Fields

> Auto-generated from the OpenAPI spec. Method names shown are the manifest > (canonical) names; per-language casing is applied by each SDK.

bulkUpdateFieldOrder

PUT /field/order/

Reorder field inputs within a group

Parameter	In	Required	Description
body	body	yes

Returns: list<Field> · Cost: 1 API call.

bulkUpdate

PUT /field

Bulk update fields

Parameter	In	Required	Description
body	body	yes

Returns: void · Cost: 1 API call.

create

POST /field

Create a field

Parameter	In	Required	Description
body	body	yes

Returns: void · Cost: 1 API call.

delete

DELETE /field/{fieldId}

Delete a field

Parameter	In	Required	Description
fieldId	path	yes	ID of field

Returns: any · Cost: 1 API call.

get

GET /field/{fieldId}

Get a field definition

Parameter	In	Required	Description
fieldId	path	yes	ID of field

Returns: void · Cost: 1 API call.

listFieldGroupInputs

GET /field-group/{groupId}/input

List fields of a group

Parameter	In	Required	Description
groupId	path	yes	ID of field group
filter	query	no	Filter expression to narrow results. Format: field operator value. Multiple conditions are joined with ; or & (AND) or | (OR). Conditions can be grouped with parentheses. Supported operators: = (equals; also matches NULL when value is empty), != (not equals), >, >=, <, <=, ~ (LIKE, use % as wildcard; empty value matches NULL/empty), !~ (NOT LIKE), ... (IN set, comma-separated: statusId...1,2,3). OR across values for one field: status=(active|pending). Examples: filter=name=Acme, filter=created>=2024-01-01;assigneeId=, filter=name~%smith%;statusId...1,2,3, filter=(status=active|status=pending)&spaceId=5.
offset	query	no	Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30.
limit	query	no	Maximum number of records to return. Use together with offset for pagination.
order	query	no	Sort order for results. Comma-separated list of field;DIRECTION pairs. Direction is ASC or DESC (default DESC when omitted). Example: order=name;ASC or order=id;ASC,name;DESC.

Returns: void · Cost: 1 API call.

listFieldPositions

GET /field/position

List field group positions

Returns: list<any> · Cost: 1 API call per page (lazy paginator).

listFieldPositionsDeprecated

GET /custom-field/position

[Deprecated] Use /field/position — Deprecated alias kept for backward compatibility after the custom-field module was renamed to field. Responses carry an RFC 9745 Deprecation header and a successor Link header; migrate to the canonical GET /field/position.

Parameter	In	Required	Description
filter	query	no	Filter expression to narrow results. Format: field operator value. Multiple conditions are joined with ; or & (AND) or | (OR). Conditions can be grouped with parentheses. Supported operators: = (equals; also matches NULL when value is empty), != (not equals), >, >=, <, <=, ~ (LIKE, use % as wildcard; empty value matches NULL/empty), !~ (NOT LIKE), ... (IN set, comma-separated: statusId...1,2,3). OR across values for one field: status=(active|pending). Examples: filter=name=Acme, filter=created>=2024-01-01;assigneeId=, filter=name~%smith%;statusId...1,2,3, filter=(status=active|status=pending)&spaceId=5.
offset	query	no	Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30.
limit	query	no	Maximum number of records to return. Use together with offset for pagination.
order	query	no	Sort order for results. Comma-separated list of field;DIRECTION pairs. Direction is ASC or DESC (default DESC when omitted). Example: order=name;ASC or order=id;ASC,name;DESC.

Returns: list<any> · Cost: 1 API call per page (lazy paginator).

list

GET /field

List fields

Parameter	In	Required	Description
filter	query	no	Filter expression to narrow results. Format: field operator value. Multiple conditions are joined with ; or & (AND) or | (OR). Conditions can be grouped with parentheses. Supported operators: = (equals; also matches NULL when value is empty), != (not equals), >, >=, <, <=, ~ (LIKE, use % as wildcard; empty value matches NULL/empty), !~ (NOT LIKE), ... (IN set, comma-separated: statusId...1,2,3). OR across values for one field: status=(active|pending). Examples: filter=name=Acme, filter=created>=2024-01-01;assigneeId=, filter=name~%smith%;statusId...1,2,3, filter=(status=active|status=pending)&spaceId=5.
offset	query	no	Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30.
limit	query	no	Maximum number of records to return. Use together with offset for pagination.
order	query	no	Sort order for results. Comma-separated list of field;DIRECTION pairs. Direction is ASC or DESC (default DESC when omitted). Example: order=name;ASC or order=id;ASC,name;DESC.

Returns: list<Field> · Cost: 1 API call per page (lazy paginator).

listFieldsBySpace

GET /field/by-space/{spaceId}

List fields available in the given spaces — Lists field definitions available in the specified spaces. Pass space IDs as a comma-separated spaces query parameter (takes precedence) or as a path parameter.

Parameter	In	Required	Description
spaceId	path	yes	ID of space which fields to get
spaces	query	no	Array of space IDs which fields to get (separated by comma) - if set, takes precedence before spaceId parameter

Returns: list<Field> · Cost: 1 API call per page (lazy paginator).

listFieldsBySpaceDeprecated

GET /custom-field/by-space/{spaceId}

[Deprecated] Use /field/by-space/{spaceId} — Deprecated alias kept for backward compatibility after the custom-field module was renamed to field. Responses carry an RFC 9745 Deprecation header and a successor Link header; migrate to the canonical GET /field/by-space/{spaceId}.

Parameter	In	Required	Description
spaceId	path	yes	ID of space which fields to get
spaces	query	no	Array of space IDs which fields to get (separated by comma) - if set, takes precedence before spaceId parameter

Returns: list<Field> · Cost: 1 API call per page (lazy paginator).

listFieldsOf

GET /field/of/{module}/{entityId}

List fields defined for a specific entity type

Parameter	In	Required	Description
module	path	yes	Module of which fields to get
entityId	path	yes	Id of entity which fields to get

Returns: list<Field> · Cost: 1 API call per page (lazy paginator).

update

PUT /field/{fieldId}

Update a field

Parameter	In	Required	Description
fieldId	path	yes	ID of field
body	body	yes

Returns: void · Cost: 1 API call.