Labels

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

Record handle: ref(id) → a lazy handle to one Label (get/update/delete, field values, related records). See record handles.

bulkDelete

DELETE /label

Bulk delete labels

Parameter	In	Required	Description
body	body	yes	Labels - array of IDs to be deleted

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

bulkUpdate

PUT /label

Bulk update labels

Parameter	In	Required	Description
body	body	yes	Label - array of Label records to be updated

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

createFile

POST /file/{fileId}/label/{labelId}

Connect a label

Parameter	In	Required	Description
fileId	path	yes	ID of business order
labelId	path	yes	Label id

Returns: void · Cost: 1 API call.

create

POST /label

Create a label

Parameter	In	Required	Description
body	body	yes	Label to be created

Returns: Label · Cost: 1 API call.

createRecord

POST /record/{recordId}/label/{labelId}

Connect a label to a record

Parameter	In	Required	Description
recordId	path	yes	Record ID
labelId	path	yes	Label id

Returns: void · Cost: 1 API call.

deleteFile

DELETE /file/{fileId}/label/{labelId}

Disconnect a label

Parameter	In	Required	Description
fileId	path	yes	ID of file
labelId	path	yes	Label id

Returns: void · Cost: 1 API call.

delete

DELETE /label/{labelId}

Delete a label

Parameter	In	Required	Description
labelId	path	yes	ID of label

Returns: any · Cost: 1 API call.

deleteRecord

DELETE /record/{recordId}/label/{labelId}

Disconnect a label from a record

Parameter	In	Required	Description
recordId	path	yes	Record ID
labelId	path	yes	Label id

Returns: void · Cost: 1 API call.

getFile

GET /file/{fileId}/label/{labelId}

Get a connected label

Parameter	In	Required	Description
fileId	path	yes	ID of file
labelId	path	yes	Label id

Returns: Label · Cost: 1 API call.

get

GET /label/{labelId}

Get a label by ID

Parameter	In	Required	Description
labelId	path	yes	ID of label

Returns: Label · Cost: 1 API call.

getRecord

GET /record/{recordId}/label/{labelId}

Get a label connected to a record

Parameter	In	Required	Description
recordId	path	yes	Record ID
labelId	path	yes	Label id

Returns: Label · Cost: 1 API call.

listFile

GET /file/{fileId}/label

List connected labels

Parameter	In	Required	Description
fileId	path	yes	ID of file
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<Label> · Cost: 1 API call per page (lazy paginator).

listFileLabelConnectible

GET /file/{fileId}/label/connectible

List labels available to connect

Parameter	In	Required	Description
fileId	path	yes	ID of file
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<Label> · Cost: 1 API call per page (lazy paginator).

list

GET /label

List labels

Parameter	In	Required	Description
space	query	no	Filter labels by space ID. Accepts a single ID or a comma-separated list. Labels with no space (global) are always included
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<Label> · Cost: 1 API call per page (lazy paginator).

listRecord

GET /record/{recordId}/label

List labels connected to a record

Parameter	In	Required	Description
recordId	path	yes	Record ID
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<Label> · Cost: 1 API call per page (lazy paginator).

update

PUT /label/{labelId}

Update a label

Parameter	In	Required	Description
labelId	path	yes	ID of label
body	body	yes	Label - array of values to be updated

Returns: Label · Cost: 1 API call.