Sign in
Projects

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.

get/api/projects/

Query parameters

archivedboolean

Filter by projects that belong to archived workspaces

filterstring

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.

idsstring

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

includestring

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_limitinteger

Maximum number of members to return

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

Search term for project title and description

source_interface_idnumber

Filter lse_project__source_interface_id by exact match

statestring

Filter current_state by exact match

titlestring

Filter title by contains (case-insensitive)

workspacesnumber

Filter workspaces by exact match

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

Changed in 9 of the 97 revisions of this API.1619

  • c7f605974c951See the full diff
    • ○

      added the required property results/items/collection_mode to the response with the 200 status

      response-required-property-added

  • 1b113b8df95011See the full diff
    • ●

      added the new by_annotator enum value to the results/items/review_settings/sampling/allOf[ReviewSettingsSamplingEnum]/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property results/items/review_settings/annotator_batch_percent to the response with the 200 status

      response-optional-property-added

  • 0bb2c2fc7ae21See the full diff
    • ○

      added the optional property results/items/annotator_evaluation_metric to the response with the 200 status

      response-optional-property-added

  • 32a5de4a180c2See the full diff
    • ○

      added the required property results/items/internal_description to the response with the 200 status

      response-required-property-added

    • ○

      added the required property results/items/internal_description_short to the response with the 200 status

      response-required-property-added

  • b5f055b9d45b12See the full diff
    • ▲

      the response property results/items/created_by/allOf[UserSimple]/avatar became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property results/items/prompts became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property results/items/skipped_annotations_number became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property results/items/workspace_title became nullable for the status 200

      response-property-became-nullable

    • ▲

      the results/items/blueprints/items/task_count response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • ▲

      the results/items/is_dimensions_enabled response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

    • ▲

      the results/items/members response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • ▲

      the results/items/prompts response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • ▲

      the results/items/queue_total response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • ▲

      the results/items/skipped_annotations_number response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • ▲

      the results/items/total_annotations_number response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • ▲

      the results/items/workspace response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

  • 04ff286141b52See the full diff
    • ○

      added ProjectSamplingEnum to the results/items/sampling response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed SamplingDe5Enum from the results/items/sampling response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 290141244adc1See the full diff
    • ○

      added the new optional query request parameter source_interface_id

      new-optional-request-parameter

  • 56cd2009bd4d4See the full diff
    • ▲

      the response property results/items/queue_left became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property results/items/review_total_tasks became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property results/items/reviewed_number became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property results/items/reviewer_queue_total became nullable for the status 200

      response-property-became-nullable

  • b7b3b45888a81See the full diff
    • ○

      added the optional property results/items/output_schema to the response with the 200 status

      response-optional-property-added

Of the 97 revisions, 1 has no diff computed.