List projects | API Reference

1 from label_studio_sdk import LabelStudio 2 3 client = LabelStudio( 4 api_key="YOUR_API_KEY", 5 ) 6 response = client.projects.list() 7 for item in response: 8 yield item 9 # alternatively, you can paginate page-by-page 10 for page in response.iter_pages(): 11 yield page

1 { 2 "count": 123, 3 "results": [ 4 { 5 "allow_stream": "allow_stream", 6 "assignment_settings": { 7 "id": 1 8 }, 9 "blueprints": [ 10 { 11 "created_at": "2024-01-15T09:30:00Z", 12 "id": 1, 13 "share_id": "share_id", 14 "short_url": "short_url" 15 } 16 ], 17 "config_has_control_tags": true, 18 "config_suitable_for_bulk_annotation": true, 19 "created_at": "2024-01-15T09:30:00Z", 20 "data_types": { 21 "key": "value" 22 }, 23 "description_short": "description_short", 24 "finished_task_number": 1, 25 "ground_truth_number": 1, 26 "has_blueprints": "has_blueprints", 27 "id": 1, 28 "members": "members", 29 "members_count": 1, 30 "num_tasks_with_annotations": "num_tasks_with_annotations", 31 "parsed_label_config": { 32 "key": "value" 33 }, 34 "prompts": "prompts", 35 "queue_done": "queue_done", 36 "queue_left": "queue_left", 37 "queue_total": "queue_total", 38 "ready": "ready", 39 "rejected": "rejected", 40 "review_settings": { 41 "id": 1, 42 "requeue_rejected_tasks_to_annotator": true 43 }, 44 "review_total_tasks": "review_total_tasks", 45 "reviewed_number": "reviewed_number", 46 "reviewer_queue_total": "reviewer_queue_total", 47 "skipped_annotations_number": "skipped_annotations_number", 48 "start_training_on_annotation_update": true, 49 "task_number": 1, 50 "total_annotations_number": "total_annotations_number", 51 "total_predictions_number": 1, 52 "useful_annotation_number": "useful_annotation_number", 53 "workspace": "workspace", 54 "workspace_title": "workspace_title", 55 "annotation_limit_count": 1, 56 "annotation_limit_percent": "annotation_limit_percent", 57 "annotator_evaluation_minimum_score": "annotator_evaluation_minimum_score", 58 "annotator_evaluation_minimum_tasks": 1, 59 "color": "color", 60 "comment_classification_config": "comment_classification_config", 61 "control_weights": { 62 "key": "value" 63 }, 64 "created_by": { 65 "avatar": "avatar", 66 "id": 1 67 }, 68 "custom_script": "custom_script", 69 "custom_task_lock_ttl": 1, 70 "description": "description", 71 "duplication_done": true, 72 "duplication_status": "duplication_status", 73 "enable_empty_annotation": true, 74 "evaluate_predictions_automatically": true, 75 "expert_instruction": "expert_instruction", 76 "is_draft": true, 77 "is_published": true, 78 "label_config": "label_config", 79 "maximum_annotations": 1, 80 "min_annotations_to_start_training": 1, 81 "model_version": "model_version", 82 "organization": 1, 83 "overlap_cohort_percentage": 1, 84 "pause_on_failed_annotator_evaluation": true, 85 "pinned_at": "2024-01-15T09:30:00Z", 86 "require_comment_on_skip": true, 87 "reveal_preannotations_interactively": true, 88 "sampling": "Sequential sampling", 89 "show_annotation_history": true, 90 "show_collab_predictions": true, 91 "show_ground_truth_first": true, 92 "show_instruction": true, 93 "show_overlap_first": true, 94 "show_skip_button": true, 95 "skip_queue": "REQUEUE_FOR_ME", 96 "title": "title" 97 } 98 ], 99 "next": "http://api.example.org/accounts/?page=4", 100 "previous": "http://api.example.org/accounts/?page=2" 101 }

Retrieve a list of projects.

Query parameters

filterenumOptional

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.

Allowed values:

idsstringOptional

ids

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.

titlestringOptional

title

workspacesintegerOptional

workspaces

Response

countinteger

resultslist of objects

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"

Headers

Query parameters

Response