Annotations
For instructions on how to authenticate to use this endpoint, see API overview.
Create, Read, Update and Delete annotations. See docs for more information on annotations.
Endpoints
List all annotations
Required API key scopes
annotation:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
- searchstring
A search term.
Response
Status 200
Create annotations
Required API key scopes
annotation:write
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 201
Retrieve annotations
Required API key scopes
annotation:read
Path parameters
- idinteger
A unique integer value identifying this annotation.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200
Update annotations
Required API key scopes
annotation:write
Path parameters
- idinteger
A unique integer value identifying this annotation.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200
Delete annotations
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
annotation:write
Path parameters
- idinteger
A unique integer value identifying this annotation.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.