Tolgee Octri Demo
GET/v2/projects

List projects available to the authenticated user

Lists projects for which the authenticated user has at least one permission. Filter the results by project IDs or base language tag, and use page and size to paginate the results.

7 parameters
filterIdarray<integer>optional
Filter results to projects whose IDs appear in this list.
filterNotIdarray<integer>optional
Exclude projects whose IDs appear in this list.
filterBaseLanguageTagstringoptional
Filter projects by their base language tag.
pageintegeroptional
Zero-based page index. Defaults to 0 when omitted; must be 0 or greater.
Default:0
sizeintegeroptional
Number of projects per page. Defaults to 20 when omitted; must be at least 1.
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"]
searchstringoptional
Search term used to filter the returned projects.

5 status codes
200Returns a page of projects in `_embedded.projects` and pagination metadata including the page number, size, total element count, and total page count.
_embeddedobjectoptional
pageobjectoptional
400Returned when a filter, sort criterion, or pagination value is invalid.
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 is not authenticated.
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 cannot access this operation.
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 a referenced resource was not 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 filter, sort criterion, or pagination value is invalid. A 401 indicates that the request is not authenticated, and a 403 indicates that the authenticated user cannot access this operation. A 404 indicates that a referenced resource was not found.