List Projects — GET /api/v1/projects
List Projects
Endpoint: GET /api/v1/projects
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
include_archived | query | no | boolean | false | W17 ADM-04: also list archived projects, with when / by whom (ADMIN only; 403 otherwise). |
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 | array of ProjectResponse (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Errors this endpoint returns, read from its source code:
403, with the message “Only an administrator can list archived projects”
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: Projects
- Operation ID:
list_projects_api_v1_projects_get - Source code:
backend/app/routers/projects.py, line 63 - Specification: OpenAPI JSON