kimai_client_lib 1.0.0

JSON API for the Kimai time-tracking software. Read our [API documentation](https://www.kimai.org/documentation/rest-api.html) and download the [Open API definition](doc.json) to import into your API client.
Documentation 
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395

# \TeamApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_delete_team**](TeamApi.md#delete_delete_team) | **DELETE** /api/teams/{id} | Delete a team
[**delete_delete_team_activity**](TeamApi.md#delete_delete_team_activity) | **DELETE** /api/teams/{id}/activities/{activityId} | Revokes access for an activity from a team
[**delete_delete_team_customer**](TeamApi.md#delete_delete_team_customer) | **DELETE** /api/teams/{id}/customers/{customerId} | Revokes access for a customer from a team
[**delete_delete_team_member**](TeamApi.md#delete_delete_team_member) | **DELETE** /api/teams/{id}/members/{userId} | Removes a member from the team
[**delete_delete_team_project**](TeamApi.md#delete_delete_team_project) | **DELETE** /api/teams/{id}/projects/{projectId} | Revokes access for a project from a team
[**get_get_team**](TeamApi.md#get_get_team) | **GET** /api/teams/{id} | Returns one team
[**get_get_teams**](TeamApi.md#get_get_teams) | **GET** /api/teams | Fetch all existing teams (which are visible to the user)
[**patch_patch_team**](TeamApi.md#patch_patch_team) | **PATCH** /api/teams/{id} | Update an existing team
[**post_post_team**](TeamApi.md#post_post_team) | **POST** /api/teams | Creates a new team
[**post_post_team_activity**](TeamApi.md#post_post_team_activity) | **POST** /api/teams/{id}/activities/{activityId} | Grant the team access to an activity
[**post_post_team_customer**](TeamApi.md#post_post_team_customer) | **POST** /api/teams/{id}/customers/{customerId} | Grant the team access to a customer
[**post_post_team_member**](TeamApi.md#post_post_team_member) | **POST** /api/teams/{id}/members/{userId} | Add a new member to a team
[**post_post_team_project**](TeamApi.md#post_post_team_project) | **POST** /api/teams/{id}/projects/{projectId} | Grant the team access to a project



## delete_delete_team

> delete_delete_team(id)
Delete a team

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Team ID to delete | [required] |

### Return type

 (empty response body)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_delete_team_activity

> models::Team delete_delete_team_activity(id, activity_id)
Revokes access for an activity from a team

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The team whose permission will be revoked | [required] |
**activity_id** | **String** | The activity to remove (Activity ID) | [required] |

### Return type

[**models::Team**](Team.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_delete_team_customer

> models::Team delete_delete_team_customer(id, customer_id)
Revokes access for a customer from a team

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The team whose permission will be revoked | [required] |
**customer_id** | **String** | The customer to remove (Customer ID) | [required] |

### Return type

[**models::Team**](Team.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_delete_team_member

> models::Team delete_delete_team_member(id, user_id)
Removes a member from the team

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The team from which the member will be removed | [required] |
**user_id** | **String** | The team member to remove (User ID) | [required] |

### Return type

[**models::Team**](Team.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_delete_team_project

> models::Team delete_delete_team_project(id, project_id)
Revokes access for a project from a team

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The team whose permission will be revoked | [required] |
**project_id** | **String** | The project to remove (Project ID) | [required] |

### Return type

[**models::Team**](Team.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_get_team

> models::Team get_get_team(id)
Returns one team

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** |  | [required] |

### Return type

[**models::Team**](Team.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_get_teams

> Vec<models::TeamCollection> get_get_teams()
Fetch all existing teams (which are visible to the user)

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::TeamCollection>**](TeamCollection.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## patch_patch_team

> models::Team patch_patch_team(id, team_edit_form)
Update an existing team

Update an existing team, you can pass all or just a subset of all attributes (passing members will replace all existing ones)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Team ID to update | [required] |
**team_edit_form** | [**TeamEditForm**](TeamEditForm.md) |  | [required] |

### Return type

[**models::Team**](Team.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## post_post_team

> models::Team post_post_team(team_edit_form)
Creates a new team

Creates a new team and returns it afterwards

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**team_edit_form** | [**TeamEditForm**](TeamEditForm.md) |  | [required] |

### Return type

[**models::Team**](Team.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## post_post_team_activity

> models::Team post_post_team_activity(id, activity_id)
Grant the team access to an activity

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The team that is granted access | [required] |
**activity_id** | **String** | The activity to grant acecess to (Activity ID) | [required] |

### Return type

[**models::Team**](Team.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## post_post_team_customer

> models::Team post_post_team_customer(id, customer_id)
Grant the team access to a customer

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The team that is granted access | [required] |
**customer_id** | **String** | The customer to grant acecess to (Customer ID) | [required] |

### Return type

[**models::Team**](Team.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## post_post_team_member

> models::Team post_post_team_member(id, user_id)
Add a new member to a team

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The team which will receive the new member | [required] |
**user_id** | **String** | The team member to add (User ID) | [required] |

### Return type

[**models::Team**](Team.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## post_post_team_project

> models::Team post_post_team_project(id, project_id)
Grant the team access to a project

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | The team that is granted access | [required] |
**project_id** | **String** | The project to grant acecess to (Project ID) | [required] |

### Return type

[**models::Team**](Team.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)