1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
# Todos
**Note:** This feature was [introduced][ce-3188] in GitLab 8.10
## Get a list of todos
Returns a list of todos. When no filter is applied, it returns all pending todos
for the current user. Different filters allow the user to
```
GET /todos
```
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `action_id` | integer | no | The ID of the action of the todo. See the table below for the ID mapping |
| `author_id` | integer | no | The ID of an author |
| `project_id` | integer | no | The ID of a project |
| `state` | string | no | The state of the todo. Can be either `pending` or `done` |
| `type` | string | no | The type of an todo. Can be either `Issue` or `MergeRequest` |
| `action_id` | Action |
| ----------- | ------ |
| 1 | Issuable assigned |
| 2 | Mentioned in issuable |
| 3 | Build failed |
| 4 | Todo marked for you |
```bash
curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/todos
```
Example Response:
```json
[
{
"id": 130,
"project": {
"id": 1,
"name": "Underscore",
"name_with_namespace": "Documentcloud / Underscore",
"path": "underscore",
"path_with_namespace": "documentcloud/underscore"
},
"author": {
"name": "Juwan Abbott",
"username": "halle",
"id": 8,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/a0086c7b9e0d73312f32ff745fdcb43e?s=80&d=identicon",
"web_url": "https://gitlab.example.com/u/halle"
},
"action_name": "assigned",
"target_id": 71,
"target_type": "Issue",
"target_reference": "#1",
"target_url": "https://gitlab.example.com/documentcloud/underscore/issues/1",
"body": "At voluptas qui nulla soluta qui et.",
"state": "pending",
"created_at": "2016-05-20T20:52:00.626Z"
},
{
"id": 129,
"project": {
"id": 1,
"name": "Underscore",
"name_with_namespace": "Documentcloud / Underscore",
"path": "underscore",
"path_with_namespace": "documentcloud/underscore"
},
"author": {
"name": "Juwan Abbott",
"username": "halle",
"id": 8,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/a0086c7b9e0d73312f32ff745fdcb43e?s=80&d=identicon",
"web_url": "https://gitlab.example.com/u/halle"
},
"action_name": "mentioned",
"target_id": 79,
"target_type": "Issue",
"target_reference": "#9",
"target_url": "https://gitlab.example.com/documentcloud/underscore/issues/9#note_959",
"body": "@root Fix this shit",
"state": "pending",
"created_at": "2016-05-20T20:51:51.503Z"
}
]
```
## Mark a todo as done
Marks a single pending todo given by its ID for the current user as done. The to
marked as done is returned in the response.
```
DELETE /todos/:id
```
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of a todo |
```bash
curl -X DELETE -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/todos/130
```
Example Response:
```json
{
"id": 130,
"project": {
"id": 1,
"name": "Underscore",
"name_with_namespace": "Documentcloud / Underscore",
"path": "underscore",
"path_with_namespace": "documentcloud/underscore"
},
"author": {
"name": "Juwan Abbott",
"username": "halle",
"id": 8,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/a0086c7b9e0d73312f32ff745fdcb43e?s=80&d=identicon",
"web_url": "https://gitlab.example.com/u/halle"
},
"action_name": "assigned",
"target_id": 71,
"target_type": "Issue",
"target_reference": "#1",
"target_url": "https://gitlab.example.com/documentcloud/underscore/issues/1",
"body": "At voluptas qui nulla soluta qui et.",
"state": "done",
"created_at": "2016-05-20T20:52:00.626Z"
}
```
## Mark all todos as done
Marks all pending todos for the current user as done. All todos marked as done
are returned in the response.
```
DELETE /todos
```
```bash
curl -X DELETE -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/todos
```
Example Response:
```json
[
{
"id": 130,
"project": {
"id": 1,
"name": "Underscore",
"name_with_namespace": "Documentcloud / Underscore",
"path": "underscore",
"path_with_namespace": "documentcloud/underscore"
},
"author": {
"name": "Juwan Abbott",
"username": "halle",
"id": 8,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/a0086c7b9e0d73312f32ff745fdcb43e?s=80&d=identicon",
"web_url": "https://gitlab.example.com/u/halle"
},
"action_name": "assigned",
"target_id": 71,
"target_type": "Issue",
"target_reference": "#1",
"target_url": "https://gitlab.example.com/documentcloud/underscore/issues/1",
"body": "At voluptas qui nulla soluta qui et.",
"state": "done",
"created_at": "2016-05-20T20:52:00.626Z"
},
{
"id": 129,
"project": {
"id": 1,
"name": "Underscore",
"name_with_namespace": "Documentcloud / Underscore",
"path": "underscore",
"path_with_namespace": "documentcloud/underscore"
},
"author": {
"name": "Juwan Abbott",
"username": "halle",
"id": 8,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/a0086c7b9e0d73312f32ff745fdcb43e?s=80&d=identicon",
"web_url": "https://gitlab.example.com/u/halle"
},
"action_name": "mentioned",
"target_id": 79,
"target_type": "Issue",
"target_reference": "#9",
"target_url": "https://gitlab.example.com/documentcloud/underscore/issues/9#note_959",
"body": "@root Fix this shit",
"state": "done",
"created_at": "2016-05-20T20:51:51.503Z"
}
]
```
[ce-3188]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3188
|
