✨ List all annotation history items for annotation | API Reference

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

List annotation history items for an annotation. Annotation history logs all actions performed with annotations, such as: imports, submits, updates, reviews, and more. Users can view annotation history items in the Annotation History panel during labeling.

<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> List annotation history items for an annotation. Annotation history logs all actions performed with annotations, such as: imports, submits, updates, reviews, and more. Users can view annotation history items in the Annotation History panel during labeling.

Authentication

Authorizationstring

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Query parameters

annotationintegerOptional

Annotation ID to get annotation history items for.

orderingstringOptional

Which field to use when ordering the results.

Response

commentstring or null

created_atdatetime

idinteger

actionenum or null

prediction - Created from prediction
propagated_annotation - Created from another annotation
imported - Imported
submitted - Submitted
updated - Updated
skipped - Skipped
accepted - Accepted
rejected - Rejected
fixed_and_accepted - Fixed and accepted
deleted_review - Deleted review

* `prediction` - Created from prediction * `propagated_annotation` - Created from another annotation * `imported` - Imported * `submitted` - Submitted * `updated` - Updated * `skipped` - Skipped * `accepted` - Accepted * `rejected` - Rejected * `fixed_and_accepted` - Fixed and accepted * `deleted_review` - Deleted review

annotation_idinteger or null-2147483648-2147483647

Corresponding annotation for this historical annotation

comment_idinteger or null-2147483648-2147483647

Comment id sent with result

created_byinteger or null-2147483648-2147483647

Created by user id

draft_idinteger or null-2147483648-2147483647

Corresponding draft for this historical annotation

lead_timedouble or null

How much time it took to annotate the task

organization_idinteger or null-2147483648-2147483647

Organization for this annotation history

project_idinteger or null-2147483648-2147483647

Project for this annotation history

resultany or null

Labeling result

review_idinteger or null-2147483648-2147483647

AnnotationReview ID, using with review field

started_atdatetime or null

The time that a user started working on this revision of the annotation

task_idinteger or null-2147483648-2147483647

Task id

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	api_key="YOUR_API_KEY",
5	)
6	client.annotation_history.list()

1	[
2	{
3	"comment": "string",
4	"created_at": "2024-01-15T09:30:00Z",
5	"id": 1,
6	"action": "prediction",
7	"annotation_id": 1,
8	"comment_id": 1,
9	"created_by": 1,
10	"draft_id": 1,
11	"lead_time": 1.1,
12	"organization_id": 1,
13	"project_id": 1,
14	"result": null,
15	"review_id": 1,
16	"started_at": "2024-01-15T09:30:00Z",
17	"task_id": 1
18	}
19	]