List projects

GET

http://localhost:8000/api/projects/

GET

/api/projects/

1 curl http://localhost:8000/api/projects/ \
2      -H "Authorization: Token  <api_key>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "count": 123,
3   "results": [
4     {
5       "allow_stream": true,
6       "assignment_settings": {
7         "id": 12,
8         "label_stream_task_distribution": "auto_distribution",
9         "project": 101
10       },
11       "blueprints": [
12         {
13           "created_at": "2024-01-15T09:30:00Z",
14           "id": 7,
15           "share_id": "bp-7a9f3c",
16           "short_url": "https://labelstud.io/bp/7a9f3c",
17           "task_count": "150",
18           "description": "Initial annotation blueprint for image classification",
19           "title": "Image Classification Blueprint"
20         }
21       ],
22       "config_has_control_tags": true,
23       "config_suitable_for_bulk_annotation": true,
24       "created_at": "2023-11-20T14:45:00Z",
25       "data_types": {
26         "image": true,
27         "text": false,
28         "audio": false
29       },
30       "description_short": "Animal image classification",
31       "finished_task_number": 120,
32       "ground_truth_number": 15,
33       "id": 101,
34       "is_dimensions_enabled": "enabled",
35       "members": "alice,bob,charlie",
36       "members_count": 3,
37       "num_tasks_with_annotations": 110,
38       "parsed_label_config": {
39         "views": [
40           {
41             "type": "Image",
42             "name": "img",
43             "value": "$image"
44           },
45           {
46             "type": "Choices",
47             "name": "label",
48             "toName": "img",
49             "choices": [
50               "Cat",
51               "Dog"
52             ]
53           }
54         ]
55       },
56       "prompts": "Please label each image with the correct animal category.",
57       "queue_done": 100,
58       "queue_left": 30,
59       "queue_total": "130",
60       "ready": true,
61       "rejected": 5,
62       "review_settings": {
63         "id": 3,
64         "requeue_rejected_tasks_to_annotator": true,
65         "anonymize_annotations": true,
66         "instruction": "Review annotations for accuracy and completeness.",
67         "only_finished_tasks": true,
68         "project": 101,
69         "requeue_rejected_tasks_mode": "requeue",
70         "require_comment_on_reject": true,
71         "review_criteria": "all",
72         "review_only_manual_assignments": true,
73         "review_task_limit_percent": "50.00",
74         "sampling": "task_id",
75         "show_agreement_to_reviewers": true,
76         "show_data_manager_to_reviewers": true,
77         "show_instruction": true,
78         "show_unused_data_columns_to_reviewers": false
79       },
80       "review_total_tasks": 80,
81       "reviewed_number": 75,
82       "reviewer_queue_total": 10,
83       "skipped_annotations_number": "3",
84       "start_training_on_annotation_update": true,
85       "state": "active",
86       "task_number": 150,
87       "total_annotations_number": "350",
88       "total_predictions_number": 120,
89       "useful_annotation_number": 300,
90       "workspace": "wildlife_research",
91       "workspace_title": "Wildlife Research",
92       "agreement_methodology": "consensus",
93       "agreement_threshold": "0.85",
94       "annotation_limit_count": 50,
95       "annotation_limit_percent": "75.00",
96       "annotator_evaluation_continuous_tasks": 5,
97       "annotator_evaluation_enabled": true,
98       "annotator_evaluation_minimum_score": "95.00",
99       "annotator_evaluation_minimum_tasks": 10,
100       "annotator_evaluation_onboarding_tasks": 3,
101       "color": "#4A90E2",
102       "comment_classification_config": "<View><Text name=\"comment\" value=\"$comment\"/></View>",
103       "control_weights": {
104         "quality_check": {
105           "overall": 0.7,
106           "type": "Choices",
107           "labels": {
108             "pass": 1,
109             "fail": 0
110           }
111         }
112       },
113       "created_by": {
114         "avatar": "https://labelstud.io/avatars/user123.png",
115         "id": 42,
116         "username": "janedoe",
117         "email": "jane.doe@example.com",
118         "first_name": "Jane",
119         "last_name": "Doe"
120       },
121       "custom_script": "console.log('Custom plugin loaded');",
122       "custom_task_lock_ttl": 3600,
123       "description": "Project for annotating images of animals for classification tasks.",
124       "duplication_done": false,
125       "duplication_status": "pending",
126       "enable_empty_annotation": false,
127       "evaluate_predictions_automatically": true,
128       "expert_instruction": "Please follow the labeling guidelines carefully to ensure high quality.",
129       "is_draft": false,
130       "is_published": true,
131       "label_config": "<View><Image name=\"img\" value=\"$image\"/><Choices name=\"label\" toName=\"img\"><Choice value=\"Cat\"/><Choice value=\"Dog\"/></Choices></View>",
132       "max_additional_annotators_assignable": 5,
133       "maximum_annotations": 3,
134       "min_annotations_to_start_training": 50,
135       "model_version": "v1.2.3",
136       "organization": 5,
137       "overlap_cohort_percentage": 20,
138       "pause_on_failed_annotator_evaluation": false,
139       "pinned_at": "2024-04-01T10:00:00Z",
140       "require_comment_on_skip": false,
141       "reveal_preannotations_interactively": true,
142       "sampling": "Sequential sampling",
143       "show_annotation_history": true,
144       "show_collab_predictions": true,
145       "show_instruction": true,
146       "show_overlap_first": true,
147       "show_skip_button": true,
148       "show_unused_data_columns_to_annotators": false,
149       "skip_queue": "REQUEUE_FOR_ME",
150       "strict_task_overlap": true,
151       "title": "Animal Image Classification",
152       "show_ground_truth_first": false
153     }
154   ],
155   "next": "http://api.example.org/accounts/?page=4",
156   "previous": "http://api.example.org/accounts/?page=2"
157 }

Retrieve a list of projects.

Authentication

AuthorizationToken

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

archivedbooleanOptional

Filter by projects that belong to archived workspaces

filterstringOptionalDefaults to all

Filter projects by pinned status. Use ‘pinned_only’ to return only pinned projects, ‘exclude_pinned’ to return only non-pinned projects, or ‘all’ to return all projects.

idsstringOptional

Filter id by in list

includestringOptional

Comma-separated list of count fields to include in the response to optimize performance. Available fields: task_number, finished_task_number, total_predictions_number, total_annotations_number, num_tasks_with_annotations, useful_annotation_number, ground_truth_number, skipped_annotations_number. If not specified, all count fields are included.

members_limitintegerOptionalDefaults to 10

Maximum number of members to return

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

Search term for project title and description

statestringOptional

Filter current_state by exact match

titlestringOptional

Filter title by contains (case-insensitive)

workspacesdoubleOptional

Filter workspaces by exact match

Response

countinteger

resultslist of objects

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"