--- title: "List items" method: GET path: "/api/v2/teams/{team_slug}/items" tags: ["Items"] --- # List items `GET /api/v2/teams/{team_slug}/items` Returns list of Items given provided filters. ## Path parameters - `team_slug` string, required ## Query parameters - `dataset_ids[]` union, required - CommonDatasetId[] — List of dataset IDs - 'all' — All dataset IDs. - string — [ DEPRECATED ] Comma seperated list of dataset IDs - `has_comments` boolean — Controls whether to include only items with/without comments - `select_all` boolean — For batch operation this filter has to be set to true if no other optional filter is provided. - `item_path_prefix` string — Item's path prefix to match. This filter only matches on full path segments, it's not possible to match on e.g. '/some_path' with '/some' filter. - `not_item_path_prefix` string — Item's path prefix to match. This filter only matches on full path segments, it's not possible to match on e.g. '/some_path' with '/some' filter. - `item_paths[]` union - DatasetsV2FiltersItemPath[] — List of Item's path - string — [ DEPRECATED ] Comma separated list of Item's path - `not_item_paths[]` union - DatasetsV2FiltersItemPath[] — List of Item's path - string — [ DEPRECATED ] Comma separated list of Item's path - `item_ids[]` union - DatasetsV2FiltersItemId[] — List of Item's UUID - string — [ DEPRECATED ] Comma separated list of Item's UUID - `not_item_ids[]` union - DatasetsV2FiltersItemId[] — List of Item's UUID - string — [ DEPRECATED ] Comma separated list of Item's UUID - `item_names[]` union - DatasetsV2FiltersItemName[] — List of Item's name - string — [ DEPRECATED ] Comma separated list of Item's name - `not_item_names[]` union - DatasetsV2FiltersItemName[] — List of Item's name - string — [ DEPRECATED ] Comma separated list of Item's name - `item_name_prefix` string — Prefix of item's name - `not_item_name_prefix` string — Prefix of item's name - `item_name_contains` string — Partial item's name - `not_item_name_contains` string — Partial item's name - `workflow_stage_ids[]` union - DatasetsV2FiltersWorkflowStageId[] — List of Item's current workflow stage ID. - string — [ DEPRECATED ] Comma separated list of Item's current workflow stage ID. - `not_workflow_stage_ids[]` union - DatasetsV2FiltersWorkflowStageId[] — List of Item's current workflow stage ID. - string — [ DEPRECATED ] Comma separated list of Item's current workflow stage ID. - `types[]` union - DatasetsV2FiltersFileType[] — List of Type of files within the item - string — [ DEPRECATED ] Comma separated list of Type of files within the item - `not_types[]` union - DatasetsV2FiltersFileType[] — List of Type of files within the item - string — [ DEPRECATED ] Comma separated list of Type of files within the item - `statuses[]` union - DatasetsV2CommonGeneralStatus[] — List of General status of the Upload/Item. It considers processing status as well as workflow status and Item being archived/non-archived. Can be used instead of 'processing_status' and 'workflow_status' for simplicity. Item will be marked as 'complete' only if both workflow and processing is done. - string — [ DEPRECATED ] Comma separated list of General status of the Upload/Item. It considers processing status as well as workflow status and Item being archived/non-archived. Can be used instead of 'processing_status' and 'workflow_status' for simplicity. Item will be marked as 'complete' only if both workflow and processing is done. - `not_statuses[]` union - DatasetsV2CommonGeneralStatus[] — List of General status of the Upload/Item. It considers processing status as well as workflow status and Item being archived/non-archived. Can be used instead of 'processing_status' and 'workflow_status' for simplicity. Item will be marked as 'complete' only if both workflow and processing is done. - string — [ DEPRECATED ] Comma separated list of General status of the Upload/Item. It considers processing status as well as workflow status and Item being archived/non-archived. Can be used instead of 'processing_status' and 'workflow_status' for simplicity. Item will be marked as 'complete' only if both workflow and processing is done. - `annotation_class_ids[]` union - DatasetsV2FiltersAnnotationClassId[] — List of Item's class ID - string — [ DEPRECATED ] Comma separated list of Item's class ID - `not_annotation_class_ids[]` union - DatasetsV2FiltersAnnotationClassId[] — List of Item's class ID - string — [ DEPRECATED ] Comma separated list of Item's class ID - `current_assignees[]` union - WorkflowsV2ItemAssigneeId[] — List of Item's assignee ID - string — [ DEPRECATED ] Comma separated list of Item's assignee ID - `not_current_assignees[]` union - WorkflowsV2ItemAssigneeId[] — List of Item's assignee ID - string — [ DEPRECATED ] Comma separated list of Item's assignee ID - `assignees[]` union - WorkflowsV2ItemAssigneeId[] — List of Item's assignee ID - string — [ DEPRECATED ] Comma separated list of Item's assignee ID - `not_assignees[]` union - WorkflowsV2ItemAssigneeId[] — List of Item's assignee ID - string — [ DEPRECATED ] Comma separated list of Item's assignee ID - `include_thumbnails` boolean — Set to 'true' if you need the response to come with thumbnail URLs for each item. - `include_dicom_json` boolean — Set to 'true' if you need the response to come with a URL for the DICOM JSON of each slot - `include_first_sections` boolean — Set to 'true' if you need the response to come with URLs to first section for each item. - `include_workflow_data` boolean — Set to 'true' if you need the response to come with additional workflow-related data. See 'WorkflowData' schema for more details. - `include_tags` boolean — Set to 'true' if you need the response to come with tags associated with Item's slots. - `page[offset]` integer — Defines how many items matching filters need to be skipped before returning result. Default value is 0. - `page[size]` integer — Defines max number of items to return on single page. Default value is 500. - `page[to]` string, nullable — Page cursor on which to end the page. Page cursor consist of list of values that ends with UUID or integer - `page[from]` string, nullable — Page cursor from which to start the page. Page cursor consist of list of values that ends with UUID or integer - `sort[id]` 'asc' | 'desc' — Sort by ID. Default value is asc. - `sort[name]` 'asc' | 'desc' — Sort by name. Default value is asc. - `sort[priority]` 'asc' | 'desc' — Sort by priority. Default value is asc. - `sort[byte_size]` 'asc' | 'desc' — Sort by overall size. Default value is asc. - `sort[map]` 'asc' | 'desc' — Sort by mean average precision metric in an evaluation run. Default value is asc. - `sort[updated_at]` 'asc' | 'desc' — Sort by recently updated. Default value is asc. - `sort[accuracy]` 'asc' | 'desc' — Sort by accuracy metric in an evaluation run. Default value is asc. ## Response `200` DatasetsV2.ItemManagement.ListItemsResponse - DatasetsV2ItemManagementListItemsResponse — Presents list of items based on provided filters. - `items` DatasetsV2ItemManagementItem[], required - `archived` boolean, required - `cursor` string - `dataset_id` integer, required - `id` string, uuid, required - `inserted_at` string, date-time, required — Date and time when the item was inserted. - `layout` union - object — Object describing Item's layout. Version 3. - `slots_grid` array[], required — 3D grid of slots. Max dimensions are 4x4x128. - DatasetsV2CommonSlotsGridCell[] — Grid's row. - union - … - `version` 3, required — Layout version. - object — Object describing Item's layout. Version 2. - `layout_shape` integer[] - `slots` DatasetsV2CommonSlotName[], required - `type` 'grid' | 'horizontal' | 'vertical' | 'simple', required — View type. - `version` 2, required — Layout version. - object — Object describing Item's layout. Version 1. - `slots` DatasetsV2CommonSlotName[], required - `type` 'grid' | 'horizontal' | 'vertical' | 'simple', required — View type. - `version` 1, required — Layout version. - `name` string, required — Name of the Item. - `path` string, required — Path under which Item should be added to on Darwin platform. Should always be absolute. - `priority` integer, required - `processing_status` 'cancelled' | 'error' | 'uploading' | 'upload_confirmed' | 'processing' | 'complete', required — Current processing status of the Upload/Item. - `slot_types` DatasetsV2CommonSlotType[], required - `slots` DatasetsV2ItemManagementSlot[], required - `available_quality_presets` DatasetsV2ItemManagementStreamQualityPreset[] — List of available quality presets for this slot. See `/api/v2/teams/:team_slug/:item_id/slots/:slot_name/stream/:quality/sign`. - `bitrate` integer - `name` 'low' | 'medium' | 'high', required — Name of the quality preset. - `dicom_json_url` string — URL to the DICOM JSON for this Slot. In order to get this please use `include_dicom_json=true` in the request - `file_name` string, required — Name of the File. This will be included in exports for easier Item tracking. - `first_section_url` string — URL section of the Slot. In order to get this please use `include_first_sections=true` in the request. - `fps` number — Framerate which Darwin should extract frames at. - `id` string, uuid, required - `is_external` boolean, required — Whether the slot is on external storage or not. - `metadata` DatasetsV2ItemManagementMetadata — Metadata associated with the Slot. - `sectionless` boolean — A flag indicating if the slot has any real sections. - `size_bytes` integer — Size of the slot in bytes. - `slot_name` string, required — 'ID' of the Slot to identify it within the Item. It's recommended to use numeric values satarting with 1. - `streamable` boolean — Whether slot can be streamed or not. See `/api/v2/teams/:team_slug/:item_id/slots/:slot_name/stream/sign`. - `thumbnail_url` string — URL to thumbnail of the Slot. In order to get this please use `include_thumbnails=true` in the request. - `total_sections` integer, required — Number of all sections (frames/pages etc) of the Slot. In case of sectionless Slot, this number holds the 'virtual' number of total sections. - `type` 'image' | 'video' | 'pdf' | 'dicom', required — When type is ommited, it's gonna be infered from the slot's extension if possible. - `upload_id` string, uuid, required - `status` 'error' | 'uploading' | 'processing' | 'archived' | 'new' | 'annotate' | 'review' | 'complete', required — General status of the Upload/Item. It considers processing status as well as workflow status and Item being archived/non-archived. Can be used instead of 'processing_status' and 'workflow_status' for simplicity. Item will be marked as 'complete' only if both workflow and processing is done. - `tags` DatasetsV2ItemManagementItemTagType[] - `updated_at` string, date-time, required — Date and time when the item was recently updated. - `uploads` DatasetsV2ItemManagementUpload[], required - `as_frames` boolean — When set, processes the video as individual frames creating Item for each frame. - `file_name` string, required — Name of the File. This will be included in exports for easier Item tracking. - `fps` union — Framerate which Darwin should extract frames at. Should be either positive number or string 'native'. - 'native' — Instructs Darwin that it should extract frames at native framerate. - number — Framerate which Darwin should extract frames at. - `processing_error` DatasetsV2CommonProcessingError, nullable — Description of the error that occurred while processing the Upload/Item. - `http_status_code` integer, nullable — The HTTP error code, if this error is of type 'http'. - `message` string, required — Human readable message of the error. - `raw_error` string, nullable — The raw body of the error.The format and contents of this field depend both the type of error that occurred and on the provider giving the external storage service. - `stage` 'download' | 'extract' | 'upload', required — The stage of processing at which this error occurred. - `storage_key` string, nullable — Storage key (path) of the file that cause the error. - `type` 'http' | 'unknown' | 'timeout' | 'custom', required — The type of the error that occurred. - `processing_status` 'cancelled' | 'error' | 'uploading' | 'upload_confirmed' | 'processing' | 'complete', required — Current processing status of the Upload/Item. - `slot_name` string, required — 'ID' of the Slot to identify it within the Item. It's recommended to use numeric values satarting with 1. - `type` 'image' | 'video' | 'pdf' | 'dicom', required — When type is ommited, it's gonna be infered from the slot's extension if possible. - `upload_id` string, uuid, required - `workflow_data` DatasetsV2ItemManagementWorkflowData, nullable - `current_stage_instances` DatasetsV2ItemManagementWorkflowDataStageInstance[], required — List of 'current' stage instances for this item. Each entry on that list will have status: 'current'. - `active_edge` string, nullable, required - `assignee_id` integer, nullable, required — Item's assignee ID (of current stage) - `delete_annotations_snapshot_id` string, uuid, nullable, required - `exit_snapshot_id` string, uuid, nullable, required - `parent_stage_id` string, uuid, nullable, required - `skipped` boolean, required - `skipped_reason` string, nullable - `stage_id` string, uuid, nullable, required - `stage_type` 'annotate' | 'complete' | 'consensus_entrypoint' | 'consensus_test' | 'dataset' | 'discard' | 'model' | 'review' | 'webhook' | 'archive' | 'logic' | 'sampling' | 'parallel_blind' | 'ai_review', required - `workflow_id` string, uuid, nullable - `workflow_status` 'new' | 'annotate' | 'review' | 'complete', nullable, required — Current workflow status of the Upload/Item. - `page` DatasetsV2CommonPageOutput, required — Paging information. With default sorting, cursors are always Item IDs. - `count` integer, required — Element count on current page. - `next` string, nullable, required — Use this to specify 'from' cursor of next page. - `previous` string, nullable, required — Use this to specify 'to' cursor of previous page. ## Other responses - `401` — Common.APIError - `404` — Common.APIError - `422` — Unprocessible Entity --- [API](https://skmtc.net/v7labs/apis/darwin.md) · [All operations](https://skmtc.net/v7labs/apis/darwin/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/v7labs/darwin/versions/526a5b6b4cdc/schema)