---
title: "Query items"
method: GET
path: "/api/v1/items"
tags: ["Items"]
---

# Query items

`GET /api/v1/items`

The returned item includes:
- `parentRelativeSortOrder`: Only populated for child items. Used to order children within their parent's hierarchy.
- `relations.children`: Child item IDs ordered by order within the parent's hierarchy.

## Query parameters

- `Completed` boolean
- `AssignedUserId` string, uuid
- `OwnerId` string, uuid
- `StatusId` string, uuid
- `RowId` string, uuid
- `BoardId` string, uuid
- `WorkspaceId` string, uuid
- `ParentId` string, uuid
- `CustomFields` string[]
- `CreatedSince` string, date-time
- `ModifiedSince` string, date-time
- `CompletedSince` string, date-time
- `Tags` string[]
- `IncludeChildItems` boolean
- `Skip` integer
- `Take` integer

## Response `200`

OK

- ExternalAPIContractsResponsesV1GetItemsResponse
  - `items` ExternalAPIContractsResponsesV1EntitiesItem[], nullable, required
    - `id` string, uuid, required
    - `displayId` string, nullable, required
    - `workspaceId` string, uuid, required
    - `boardId` string, uuid, nullable
    - `rowId` string, uuid, required
    - `title` string, nullable, required
    - `statusId` string, uuid, nullable
    - `ownerId` string, uuid, nullable
    - `assignedUserId` string, uuid, nullable
    - `color` integer, required
    - `startDate` string, date-time, nullable
    - `dueDate` string, date-time, nullable
    - `isScheduleLocked` boolean, required
    - `completedOn` string, date-time, nullable
    - `description` string, nullable
    - `budget` number, double, nullable
    - `estimation` number, double, nullable
    - `estimationType` string, nullable, required
    - `completed` boolean, required
    - `archived` boolean, required
    - `modifiedDate` string, date-time, required
    - `createdDate` string, date-time, required
    - `archivedDate` string, date-time, nullable
    - `totalLoggedTime` integer, required
    - `milestone` boolean, required
    - `progress` integer, nullable
    - `isSuspended` boolean, required
    - `suspendReason` string, nullable, required
    - `parentId` string, uuid, nullable
    - `tags` string[], nullable, required
    - `customFields` ExternalAPIContractsResponsesV1EntitiesCustomField[], nullable, required
      - `name` string, nullable, required
      - `value` string, nullable, required
    - `relations` ExternalAPIContractsResponsesV1EntitiesItemRelations, required
      - `children` string[], nullable, required
      - `waiting` string[], nullable, required
      - `blocking` string[], nullable, required
      - `syncCopies` string[], nullable, required
      - `waitingDependencyDirections` ExternalAPIContractsResponsesV1EntitiesDependencyDirection[], nullable, required
        - `itemId` string, uuid, required
        - `direction` string, nullable, required
      - `blockingDependencyDirections` ExternalAPIContractsResponsesV1EntitiesDependencyDirection[], nullable, required
        - `itemId` string, uuid, required
        - `direction` string, nullable, required
    - `aggregates` ExternalAPIContractsResponsesV1EntitiesItemAggregates, required
      - `budget` ExternalAPIContractsResponsesV1EntitiesAggregateValue1SystemDecimalSystemPrivateCoreLibVersion8000CultureNeutralPublicKeyToken7cec85d7bea7798e, required
        - `value` number, double, required
      - `estimation` ExternalAPIContractsResponsesV1EntitiesAggregateValue1SystemDecimalSystemPrivateCoreLibVersion8000CultureNeutralPublicKeyToken7cec85d7bea7798e, required
        - `value` number, double, required
      - `totalLoggedTime` ExternalAPIContractsResponsesV1EntitiesAggregateValue1SystemInt32SystemPrivateCoreLibVersion8000CultureNeutralPublicKeyToken7cec85d7bea7798e, required
        - `value` integer, required
      - `startDate` ExternalAPIContractsResponsesV1EntitiesAggregateValue1SystemDateTimeSystemPrivateCoreLibVersion8000CultureNeutralPublicKeyToken7cec85d7bea7798e, required
        - `value` string, date-time, required
      - `dueDate` ExternalAPIContractsResponsesV1EntitiesAggregateValue1SystemDateTimeSystemPrivateCoreLibVersion8000CultureNeutralPublicKeyToken7cec85d7bea7798e, required
        - `value` string, date-time, required
      - `duration` ExternalAPIContractsResponsesV1EntitiesAggregateValue1SystemInt32SystemPrivateCoreLibVersion8000CultureNeutralPublicKeyToken7cec85d7bea7798e, required
        - `value` integer, required
      - `progress` ExternalAPIContractsResponsesV1EntitiesAggregateValue1SystemInt32SystemPrivateCoreLibVersion8000CultureNeutralPublicKeyToken7cec85d7bea7798e, required
        - `value` integer, required
      - `customFields` ExternalAPIContractsResponsesV1EntitiesCustomField[], nullable, required
        - `name` string, nullable, required
        - `value` string, nullable, required
    - `url` string, nullable, required
    - `hasAttachments` boolean, required
    - `duration` integer, nullable
    - `sortOrder` integer, required
    - `parentRelativeSortOrder` integer, nullable
    - `baselines` ExternalAPIContractsResponsesV1EntitiesBaseline[], nullable, required
      - `startDate` string, date-time, nullable
      - `dueDate` string, date-time, nullable
      - `estimation` number, double, nullable
      - `budget` number, double, nullable
      - `duration` integer, nullable
  - `nextPageUrl` string, nullable, required

---

[API](https://skmtc.net/teamhood/apis/teamhood-api-v1.md) · [All operations](https://skmtc.net/teamhood/apis/teamhood-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/teamhood/teamhood-api-v1/versions/85a10c67381d/schema)
