List Retention Holds — GET /api/v1/projects/{project_id}/retention-holds
List Retention Holds
The project’s retention holds — any member (and a key bound to the project, read only). Writes nothing.
Endpoint: GET /api/v1/projects/{project_id}/retention-holds
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- You must be a member of the project. Admins always have access.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
project_id | path | yes | string (uuid) | ||
state | query | no | string | live | |
entity_type | query | no | string or null | ||
entity_id | query | no | string (uuid) or null | ||
limit | query | no | integer | 50 | |
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | RetentionHoldListResponse (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Retention
- Operation ID:
list_retention_holds_api_v1_projects__project_id__retention_holds_get - Source code:
backend/app/routers/retention.py, line 833 - Specification: OpenAPI JSON