✨ List workspace projects | API Reference

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

Retrieve a list of all projects in a specific workspace.

<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> Retrieve a list of all projects in a specific workspace.

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>

Path parameters

idintegerRequired

Response

Projects list

config_has_control_tagsbooleanRead-only

Flag to detect is project ready for labeling

config_suitable_for_bulk_annotationbooleanRead-only

Flag to detect is project ready for bulk annotation

created_atdatetimeRead-only

finished_task_numberintegerRead-only

Finished tasks

ground_truth_numberintegerRead-only

Honeypot annotation number in project

idintegerRead-only

num_tasks_with_annotationsintegerRead-only

Tasks with annotations count

parsed_label_configmap from strings to anyRead-only

JSON-formatted labeling configuration

queue_doneintegerRead-only

queue_totalintegerRead-only

skipped_annotations_numberintegerRead-only

Skipped by collaborators annotation number in project

start_training_on_annotation_updatebooleanRead-only

Start model training after any annotations are submitted or updated

statestringRead-only

task_numberintegerRead-only

Total task number in project

total_annotations_numberintegerRead-only

Total annotations number in project including skipped_annotations_number and ground_truth_number.

total_predictions_numberintegerRead-only

Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.

useful_annotation_numberintegerRead-only

Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number

annotator_evaluation_enabledboolean or null

Enable annotator evaluation for the project

colorstring or null<=16 characters

control_weightsmap from strings to any or null

Dict of weights for each control tag in metric calculation.

created_byobject or null

Project owner

descriptionstring or null

Project description

enable_empty_annotationboolean or null

Allow annotators to submit empty annotations

evaluate_predictions_automaticallyboolean or null

Retrieve and display predictions when loading a task

expert_instructionstring or null

Labeling instructions in HTML format

is_draftboolean or null

Whether or not the project is in the middle of being created

is_publishedboolean or null

Whether or not the project is published to annotators

label_configstring or null

Label config in XML format. See more about it in documentation

maximum_annotationsinteger or null-2147483648-2147483647

Maximum number of annotations for one task. If the number of annotations per task is equal or greater to this value, the task is completed (is_labeled=True)

min_annotations_to_start_traininginteger or null-2147483648-2147483647

Minimum number of completed tasks after which model training is started

model_versionstring or null

Machine learning model version

organizationinteger or null

overlap_cohort_percentageinteger or null-2147483648-2147483647

pinned_atdatetime or null

Pinned date and time

reveal_preannotations_interactivelyboolean or null

Reveal pre-annotations interactively

samplingenum or null

Sequential sampling - Tasks are ordered by Data manager ordering
Uniform sampling - Tasks are chosen randomly
Uncertainty sampling - Tasks are chosen according to model uncertainty scores (active learning mode)

* `Sequential sampling` - Tasks are ordered by Data manager ordering * `Uniform sampling` - Tasks are chosen randomly * `Uncertainty sampling` - Tasks are chosen according to model uncertainty scores (active learning mode)

Allowed values:

show_annotation_historyboolean or null

Show annotation history to annotator

show_collab_predictionsboolean or null

If set, the annotator can view model predictions

show_instructionboolean or null

Show instructions to the annotator before they start

show_overlap_firstboolean or null

show_skip_buttonboolean or null

Show a skip button in interface and allow annotators to skip the task

skip_queueenum or null

REQUEUE_FOR_ME - Requeue for me
REQUEUE_FOR_OTHERS - Requeue for others
IGNORE_SKIPPED - Ignore skipped

* `REQUEUE_FOR_ME` - Requeue for me * `REQUEUE_FOR_OTHERS` - Requeue for others * `IGNORE_SKIPPED` - Ignore skipped

Allowed values:

task_data_loginstring or null<=256 characters

Task data credentials: login

task_data_passwordstring or null<=256 characters

Task data credentials: password

titlestring or null3-50 characters

Project name. Must be between 3 and 50 characters long.

show_ground_truth_firstboolean or nullDeprecated

Onboarding mode (true): show ground truth tasks first in the labeling stream

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	base_url="http://localhost:8000",
5	api_key="YOUR_API_KEY_HERE"
6	)
7
8	client.workspaces.projects.list(
9	id=1
10	)

1	[
2	{
3	"config_has_control_tags": true,
4	"config_suitable_for_bulk_annotation": true,
5	"created_at": "2024-01-15T09:30:00Z",
6	"finished_task_number": 120,
7	"ground_truth_number": 15,
8	"id": 101,
9	"num_tasks_with_annotations": 110,
10	"parsed_label_config": {
11	"views": [
12	{
13	"type": "Text",
14	"name": "text",
15	"value": "$text"
16	}
17	]
18	},
19	"queue_done": 115,
20	"queue_total": 150,
21	"skipped_annotations_number": 5,
22	"start_training_on_annotation_update": true,
23	"state": "active",
24	"task_number": 150,
25	"total_annotations_number": 350,
26	"total_predictions_number": 200,
27	"useful_annotation_number": 330,
28	"annotator_evaluation_enabled": true,
29	"color": "#4A90E2",
30	"control_weights": {
31	"tag_quality": 0.7,
32	"tag_accuracy": 0.3
33	},
34	"created_by": {
35	"avatar": "https://labelstud.io/media/avatars/jane_doe.png",
36	"id": 42,
37	"email": "jane.doe@example.com",
38	"first_name": "Jane",
39	"last_name": "Doe"
40	},
41	"description": "Project for annotating customer support chat transcripts.",
42	"enable_empty_annotation": false,
43	"evaluate_predictions_automatically": true,
44	"expert_instruction": "<p>Please label all customer intents carefully according to the guidelines.</p>",
45	"is_draft": false,
46	"is_published": true,
47	"label_config": "<View><Text name=\"text\" value=\"$text\"/></View>",
48	"maximum_annotations": 3,
49	"min_annotations_to_start_training": 50,
50	"model_version": "v1.3.0",
51	"organization": 7,
52	"overlap_cohort_percentage": 20,
53	"pinned_at": "2024-02-01T12:00:00Z",
54	"reveal_preannotations_interactively": true,
55	"sampling": "Sequential sampling",
56	"show_annotation_history": true,
57	"show_collab_predictions": true,
58	"show_instruction": true,
59	"show_overlap_first": false,
60	"show_skip_button": true,
61	"skip_queue": "REQUEUE_FOR_ME",
62	"task_data_login": "data_user",
63	"task_data_password": "securePass123",
64	"title": "Customer Support Chat Annotation",
65	"show_ground_truth_first": false
66	}
67	]