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

List project prompts

Lists prompts configured for a project. Use search to filter prompts and page, size, and sort to control the returned page and ordering.

5 parameters
projectIdintegerrequired
The integer identifier of the project whose prompts to list.
pageintegeroptional
Zero-based page index. Defaults to 0 when omitted and must be 0 or greater.
Default:0
sizeintegeroptional
Number of prompts to return per page. Defaults to 20 when omitted and must be at least 1.
Default:20
sortarray<string>optional
Sorting criteria in `property,(asc|desc)` format; supports multiple criteria and uses ascending order by default.
searchstringoptional
Text used to filter the prompts returned.

5 status codes
200Returns a paginated response containing prompt records and page metadata, including the page number, size, total elements, and total pages.
_embeddedobjectoptional
pageobjectoptional
400Returned when a request parameter is invalid, such as a negative page index or a size below 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 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 does not have permission to list prompts for the project.
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 is 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 for invalid request values; a 401 is returned when authentication is missing or invalid; a 403 is returned when the authenticated user lacks permission; and a 404 is returned when the project is not found. The projectId path parameter must identify the project; page must be zero or greater, size must be at least 1, and each sort value must use the property,(asc|desc) format.