/api/v1/object/field/tagsList the active tag fields of all objects, one page at a time.
List the active tag fields of all objects, one page at a time.
Returns each active field of type tag with its options and the object
it belongs to. Each option's id is returned as slug. To manage the
workspace tag list itself, use GET /object/field/tag.
Query parameters:
page— page number, from 1. Default1.limit— page size, 1 to 200. Default50.
Other query parameters, including search, are rejected with 422.
Scope: object.read.
Response 200:
{
"status": 200,
"message": "TAG fields retrieved successfully",
"data": [
{
"slug": "tag-r4t6y8u0",
"name": "tag",
"label": "Tags",
"options": {
"values": [
{
"slug": "3f1c9a2e-7b4d-4e0a-9c61-2d8f5b0e41a7",
"value": "VIP",
"label": "VIP",
"color": "#F59E0B"
}
]
},
"object": {
"slug": "task",
"name": "Tasks",
"icon": "tabler-checklist"
}
}
],
"pagination": {
"total": 1,
"page": 1,
"limit": 50,
"totalPages": 1,
"nextPage": null,
"prevPage": null
}
}
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
Successful response
{
"slug": "string",
"name": "string",
"label": "string",
"options": "string",
"object": "string"
}Archived (deleted-but-still-referenced) options are stripped — see FieldResponseDto.
Bad request
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Unauthorized
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Internal server error
{
"status": 1,
"message": "string",
"code": "string",
"data": {}
}The HTTP status code of the response.
What went wrong. Several validation messages are joined with ", ".
A stable, machine-readable reason. Only some errors set it.
Extra detail about the error. Only some errors set it.
Powered by heyo-docs