Projects

List all projects

GET

Return a list of the projects within your organization.

To perform most tasks with the Label Studio API, you must specify the project ID, sometimes referred to as the pk. The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using this API call.

To retrieve a list of your Label Studio projects, update the following command to match your own environment. Replace the domain name, port, and authorization token, then run the following from the command line:

$curl -X GET https://localhost:8080/api/projects/ -H 'Authorization: Token abc123'

Query parameters

orderingstringOptional
Which field to use when ordering the results.
idsstringOptional
ids
titlestringOptional
title
pageintegerOptional
A page number within the paginated result set.
page_sizeintegerOptional
Number of results to return per page.

Response

This endpoint returns an object
count
integer
results
list of objects
next
stringOptional
previous
stringOptional
GET
1curl http://localhost:8080/api/projects/ \
2 -H "Authorization: Token <api_key>"
200Retrieved
1{
2 "count": 1,
3 "results": [
4 {
5 "id": 1,
6 "title": "title",
7 "description": "description",
8 "label_config": "label_config",
9 "expert_instruction": "expert_instruction",
10 "show_instruction": true,
11 "show_skip_button": true,
12 "enable_empty_annotation": true,
13 "show_annotation_history": true,
14 "organization": 1,
15 "color": "color",
16 "maximum_annotations": 1,
17 "is_published": true,
18 "model_version": "model_version",
19 "is_draft": true,
20 "created_at": "2024-01-15T09:30:00Z",
21 "min_annotations_to_start_training": 1,
22 "start_training_on_annotation_update": "start_training_on_annotation_update",
23 "show_collab_predictions": true,
24 "num_tasks_with_annotations": 1,
25 "task_number": 1,
26 "useful_annotation_number": 1,
27 "ground_truth_number": 1,
28 "skipped_annotations_number": 1,
29 "total_annotations_number": 1,
30 "total_predictions_number": 1,
31 "sampling": "Sequential sampling",
32 "show_ground_truth_first": true,
33 "show_overlap_first": true,
34 "overlap_cohort_percentage": 1,
35 "task_data_login": "task_data_login",
36 "task_data_password": "task_data_password",
37 "evaluate_predictions_automatically": true,
38 "config_has_control_tags": "config_has_control_tags",
39 "skip_queue": "REQUEUE_FOR_ME",
40 "reveal_preannotations_interactively": true,
41 "pinned_at": "2024-01-15T09:30:00Z",
42 "finished_task_number": 1,
43 "queue_total": "queue_total",
44 "queue_done": "queue_done"
45 }
46 ],
47 "next": "next",
48 "previous": "previous"
49}