> ## Welcome to TimeCamp API documentation > We provide you with REST-style Open Web API, which consists of some basic methods for collecting data and manipulating TimeCamp resources, so you could flexibly adapt our product to your needs. ## Getting started > > Our base API address is ``https://app.timecamp.com/third_party/api``. SSL only. > ## Authentication > > Each TimeCamp account has its own individual API access token. You can check yours [here](https://app.timecamp.com/app#/settings/users/me). That token is permanent and can be only revoked by refreshing your API token in TimeCamp Web App. To authenticate yourself, simply add your token to ``Authorization`` header and that is it! > ### Example: >Request: >```yaml http >curl --location --request GET 'https://app.timecamp.com/third_party/api/user?format=json' \ > --header 'Authorization: yourTokenHere' >``` >Response: >```yaml http >{ > "user_id": "1111111", > "language": "1", > "email": "client@clientsdomain.com", > "login_count": "710", > "login_time": "2021-03-03 08:36:27", > "display_name": "Dear Customer", > "time_zone": "0", > "root_group_id": "1100", > "summary": "1", > "agent": "1.7.1.6|", > "primary_group_id": 2000 >} >``` ## Parametrizing your request > If you would like to add request parameters to GET or DELETE request, add them to your URL as query params. ### Example: Getting task info by task_id >Request: >```yaml http > curl --location --request GET 'https://app.timecamp.local/third_party/api/tasks?task_id=15068761' \ > --header 'Authorization: yourTokenHere' >``` >Response: >```yaml http > > 15068761 > 0 > Test task > > > 1 > 2017-05-23 09:17:16 > 1 > #76B6BB > > 0 > > 1208 > > 104523 > > > > > > 1 > > > 2019-02-12 07:32:49 > 4 > > 0 > 0 > 0 > 0 > 0 > 0 > > > >``` > In case of POST and PUT request use form urlencoded fields. ### Example: Post request - creating new task. >Request: >```yaml http >curl --location --request POST 'https://app.timecamp.local/third_party/api/tasks' \ >--header 'Authorization: yourTokenHere' \ >--header 'Content-Type: application/x-www-form-urlencoded' \ >--data-urlencode 'name=NewTask' \ >--data-urlencode 'parent_id=0' \ >--data-urlencode 'note=NewNote' >``` >Response: >```yaml http > > > > 81989452 > 0 > NewTask > > > 1 > 2021-03-04 09:06:21 > 0 > #34C644 > > 0 > > 1111 > > 2222 > > NewNote > > > > 1 > hours > > > > >``` ## Changing response format If you would like to change default ``xml`` response format, just add desired format to your URL under ``format`` query key. #### Available formats > - xml (default) > - json > - csv > - other: rawxml, jsonp, serialized, php ### Example: Creating new task with response in json format. > Request: >```yaml http >curl --location --request POST 'https://app.timecamp.local/third_party/api/tasks?format=json' \ >--header 'Authorization: yourTokenHere' \ >--data-urlencode 'name=NewTask' \ >--data-urlencode 'parent_id=0' \ >--data-urlencode 'note=NewNot' >``` > Response: >```yaml http >{ > "81989455": { > "task_id": "81989455", > "parent_id": "0", > "name": "NewTask", > "external_task_id": null, > "external_parent_id": null, > "level": "1", > "add_date": "2021-03-04 09:13:43", > "archived": "0", > "color": "#34C644", > "tags": "", > "budgeted": "0", > "checked_date": null, > "root_group_id": "1111", > "assigned_to": null, > "assigned_by": "2222", > "due_date": null, > "note": "NewNot", > "context": null, > "folder": null, > "repeat": null, > "billable": "1", > "budget_unit": "hours", > "public_hash": null, > "modify_time": null > } >} >``` ## Errors In case of error, request will return 4xx or 5xx status code. You should be able to get error message in response. ### Example Trying to add new task, but forgot to send task name. >Request: >```yaml http >curl --location --request POST 'https://app.timecamp.local/third_party/api/tasks?format=json' \ >--header 'Authorization: yourToken' >``` >Response: >```yaml http > Status code 400 >{ > "message": "You must provide a name for the task with post field: name" >} >``` ## Contact If you have questions or suggestions regarding our API please contact us at [support@timecamp.com](mailto:support@timecamp.com). ## Changelog Changelog can be found [here](https://developer.timecamp.com/docs/timecamp-api/docs/Timecamp-api-changelog.md).