Tolgee Octri Demo
GET/v2/projects/{projectId}/labels

List available labels for a project

Lists the available labels for a project, with optional text search and sorting. Use page and size to paginate the results, and use sort to choose one or more sorting criteria.

5 parameters
projectIdintegerrequired
The int64 identifier of the project whose labels to list.
searchstringoptional
Text to filter labels by.
pageintegeroptional
Zero-based page index. Defaults to 0 when omitted.
Default:0
sizeintegeroptional
Number of labels per page; must be at least 1. Defaults to 20 when omitted.
Default:20
sortarray<string>optional
Sorting criteria in `property,(asc|desc)` format; you can provide multiple criteria. Defaults to `name,ASC` when omitted.
Default:["name,ASC"]

5 status codes
200Returns a page of labels with pagination metadata, including the page number, page size, total elements, and total pages.
_embeddedobjectoptional
pageobjectoptional
400Returned when a query parameter is invalid, including when `page` is negative or `size` is less than 1.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request has no valid authentication.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user does not have permission to view the project's labels.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the project cannot be found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when a query parameter is invalid. A 401 is returned when authentication is missing or invalid. A 403 is returned when the authenticated user lacks access. A 404 is returned when the project cannot be found. The projectId path parameter must identify the project. page must be 0 or greater, and size must be at least 1.