Skip to navigation
API ReferenceProjects

List projects

Retrieve a list of projects. Counter fields in each result follow one of two scopes:

  • Per-user progress — computed for the authenticated user and their project role (for example reviewed_number, review_total_tasks, queue_done, queue_total, queue_left). These power project-card progress in the UI and differ across users. Note: queue_left counts manual review assignments only; when it is 0, the card uses review_total_tasks / reviewed_number for auto-review progress.
  • Project-wide totals — the same for every caller (for example task_number, finished_task_number).

For organization-level reviewed-task totals (all reviewers combined), use GET /api/analytics/kpis/tasks_reviewed?projects={id}&tz=UTC rather than reviewed_number. See Analytics KPI tasks_reviewed, tasks_pending_review, annotated_tasks, and total_tasks for other project-wide metrics.

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]”

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

Multiple values may be separated by commas. (comma-separated values)

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.

is_skill_assessmentbooleanOptional
Filter by skill assessments
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
source_interface_iddoubleOptional

Filter lse_project__source_interface_id by exact match

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 nullOptionalformat: "uri"
previousstring or nullOptionalformat: "uri"