# Issue Work Items

Resource that provides access to work items.
|  Resource  |     ```GENERIC /api/workItems ```    |
| --- | --- |
|  Returned entity  |  [IssueWorkItem](api-entity-IssueWorkItem.html). For the description of the entity attributes, see [Supported Fields](#IssueWorkItem-supported-fields) section.  |
|  Supported methods  |      * `GET`: [Read a List of IssueWorkItems](#get_all-IssueWorkItem-method).    |

## IssueWorkItem attributes

Represents a work item in an issue.

### Related Resources

Below you can find the list of resources that let you work with this entity.

* [Work Items]()

* [Work Items in an Issue](resource-api-issues-issueID-timeTracking-workItems.html)

Extends [BaseWorkItem](api-entity-BaseWorkItem.html)

### Attributes

This table describes attributes of the `IssueWorkItem` entity.

* To receive an attribute in the response from the server, specify it explicitly in the `fields` request parameter.

* To update an attribute, provide it in the body of a POST request.

|  Field  |  Type  |  Description  |
| --- | --- | --- |
|  id  |  String  |  The ID of the issue work item. `Read-only`.  |
|  author  |  [User](api-entity-User.html)  |  The user to whom the work is attributed in the work item. `Can be null`.  |
|  creator  |  [User](api-entity-User.html)  |  The user who added the work item to the issue. `Read-only`. `Can be null`.  |
|  text  |  String  |  The work item description. `Can be null`.  |
|  textPreview  |  String  |  Parsed preview of the description. `Read-only`.  |
|  type  |  [WorkItemType](api-entity-WorkItemType.html)  |  The work item type. `Can be null`.  |
|  created  |  Long  |  The timestamp in milliseconds indicating the moment when the work item was created. Stored as a unix timestamp at UTC.  |
|  updated  |  Long  |  The timestamp in milliseconds indicating the last update of the work item. Stored as a unix timestamp at UTC. `Can be null`.  |
|  duration  |  [DurationValue](api-entity-DurationValue.html)  |  The duration of the work item.  |
|  date  |  Long  |  The timestamp in milliseconds indicating the date and time of the work item. Stored as a Unix timestamp in UTC. The time part is set to midnight for the current date.  |
|  issue  |  [Issue](api-entity-Issue.html)  |  Stores attributes of the issue to which the work item is attached. `Read-only`.  |
|  attributes  |  [Array of WorkItemAttributes](api-entity-WorkItemAttribute.html)  |  The list of attributes of the work item. `Read-only`.  |

## Read a List of IssueWorkItems

Get all work items that belong to issues that match a search query. If the query is not provided, all work items from all issues are returned.

### Request syntax

```GENERIC
GET /api/workItems?{fields}&{$top}&{$skip}&{query}&{startDate}&{endDate}&{start}&{end}&{createdStart}&{createdEnd}&{updatedStart}&{updatedEnd}&{author}&{creator}
```

|  null  |  The database ID of IssueWorkItem  |
| --- | --- |

### Request parameters

|  Parameter  |  Type  |  Description  |
| --- | --- | --- |
|  fields  |  String  |  A list of IssueWorkItem attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.  |
|  $skip  |  Int  |  Optional. Lets you set a number of returned entities to skip before returning the first one.  |
|  $top  |  Int  |     Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries.       The server returns a maximum of 42 entries for most resources that return collections. For more information, see [Pagination](api-concept-pagination.html).     |
|  query  |  String  |  Issue search query. Read more about the search syntax here: [Search Query Reference](https://www.jetbrains.com.cn/en-us/help/youtrack/cloud/?Search-and-Command-Attributes)  |
|  startDate  |  Date  |  The start date of the time interval where the work item dates belong. Accepts a date in a string format: `YYYY-MM-DD`.  |
|  endDate  |  Date  |  The end date of the time interval where the work item dates belong. Accepts a date in a string format: `YYYY-MM-DD`.  |
|  start  |  Long  |  A timestamp in milliseconds indicating the start of the interval where the work item dates belong.  |
|  end  |  Long  |  A timestamp in milliseconds indicating the end of the interval where the work item dates belong.  |
|  createdStart  |  Long  |  A timestamp in milliseconds indicating the start of the interval during which work items were created.  |
|  createdEnd  |  Long  |  A timestamp in milliseconds indicating the end of the interval during which work items were created.  |
|  updatedStart  |  Long  |  A timestamp in milliseconds indicating the start of the interval during which work items were updated.  |
|  updatedEnd  |  Long  |  A timestamp in milliseconds indicating the end of the interval during which work items were updated.  |
|  author  |  String  |     Lets you filter work items by their author.       Possible values:        * Database ID of the user.    * Login of the user.    * `ringId` value, or the ID of the user in Hub.    * `me` value for the currently logged in user.      Include a separate `author` parameter in your request URI for each author value that you want to see in the response.     |
|  creator  |  String  |     Lets you filter work items by their creator.       Possible values:        * Database ID of the user.    * Login of the user.    * `ringId` value, or the ID of the user in Hub.    * `me` value for the currently logged in user.      Include a separate `creator` parameter in your request URI for each creator value that you want to see in the response.     |

### Sample

#### Sample request

```CURL
https://example.youtrack.cloud/api/workItems?$top=3&fields=created,duration(presentation,minutes),author(name),creator(name),date,id&author=john.smith&author=minnie.terry
```

#### Sample response body

```JSON
[
  {
    "date": 1471996800000,
    "created": 1472199143298,
    "duration": {
      "minutes": 480,
      "presentation": "8h",
      "$type": "DurationValue"
    },
    "creator": {
      "name": "John Smith",
      "$type": "User"
    },
    "author": {
      "name": "John Smith",
      "$type": "User"
    },
    "id": "124-0",
    "$type": "IssueWorkItem"
  },
  {
    "date": 1471910400000,
    "created": 1472199212097,
    "duration": {
      "minutes": 480,
      "presentation": "8h",
      "$type": "DurationValue"
    },
    "creator": {
      "name": "Minnie Terry",
      "$type": "User"
    },
    "author": {
      "name": "Minnie Terry",
      "$type": "User"
    },
    "id": "124-2",
    "$type": "IssueWorkItem"
  },
  {
    "date": 1473811200000,
    "created": 1473863404279,
    "duration": {
      "minutes": 480,
      "presentation": "8h",
      "$type": "DurationValue"
    },
    "creator": {
      "name": "Minnie Terry",
      "$type": "User"
    },
    "author": {
      "name": "Minnie Terry",
      "$type": "User"
    },
    "id": "124-4",
    "$type": "IssueWorkItem"
  }
]
```