List Timeline Notes — GET /api/v1/projects/{project_id}/timeline-notes
List Timeline Notes
The notes overlapping from.. to (inclusive), at most 200.
Endpoint: GET /api/v1/projects/{project_id}/timeline-notes
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) | ||
from | query | yes | string (date) | The window’s first UTC day (YYYY-MM-DD). | |
to | query | yes | string (date) | The window’s last UTC day; at most 366 days after from. | |
suite | query | no | string or null | Keep the project-wide notes and this suite’s (any case). Omit for every note. | |
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 | TimelineNoteList (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: Timeline notes
- Operation ID:
list_timeline_notes_api_v1_projects__project_id__timeline_notes_get - Source code:
backend/app/routers/timeline_notes.py, line 68 - Specification: OpenAPI JSON