API ReferenceProjects

List all projects

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'

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

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.
workspacesintegerOptional
workspaces
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.

filterenumOptionalDefaults 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.

Allowed values:

Response

countinteger
resultslist of objects
nextstring or nullformat: "uri"
previousstring or nullformat: "uri"