Tolgee Octri Demo
GET/v2/api-keys

List the authenticated user's API keys

Lists the authenticated user's API keys in a paginated result. Set filterProjectId to limit the results to keys associated with a specific project. Use the pageable query object to control the page index, page size, and sorting.

2 parameters
pageableobjectrequired
Pagination and sorting settings. `page` is a zero-based index, `size` must be at least 1, and `sort` accepts an array of sorting criteria.
filterProjectIdintegeroptional
The integer identifier of a project to filter the API keys by.

5 status codes
200Returns a page of API keys with pagination metadata, including the page number, page size, total key count, and total pages.
_embeddedobjectoptional
pageobjectoptional
400Returned when the pagination settings or another query 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 unauthenticated.
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 lacks access to the requested API keys.
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 requested resource 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 when pageable or another query value is invalid, a 401 when the request is unauthenticated, a 403 when the authenticated user lacks access to the requested keys, and a 404 when the requested resource is not found. pageable.page must be 0 or greater, and pageable.size must be at least 1.