Skip to content

Commit db248bd

Browse files
alan-nullalan-null
committed
Toggl.API - specification
1 parent 2d36300 commit db248bd

13 files changed

+999
-0
lines changed

‎spec/Projects/DELETE WorkspaceProject.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
## DELETE WorkspaceProject [​#](https://engineering.toggl.com/docs/api/projects/#delete-workspaceproject "Direct link to DELETE WorkspaceProject")
2+
3+
```
4+
https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/projects/{project_id}
5+
```
6+
7+
Delete project for given workspace.
8+
9+
```
10+
curl -X DELETE https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/projects/{project_id} \
11+
-H "Content-Type: application/json" \
12+
-u <email>:<password>
13+
```
14+
15+
### Parameters [​#](https://engineering.toggl.com/docs/api/projects/#parameters-10 "Direct link to Parameters")
16+
17+
#### Path [​#](https://engineering.toggl.com/docs/api/projects/#path-10 "Direct link to Path")
18+
19+
| name | type | required | description |
20+
| :----------- | :------ | :------- | :-------------------------- |
21+
| workspace_id | integer | true | Numeric ID of the workspace |
22+
| project_id | integer | true | Numeric ID of the project |
23+
24+
#### Query [​#](https://engineering.toggl.com/docs/api/projects/#query-4 "Direct link to Query")
25+
26+
| name | type | required | description |
27+
| :------------- | :----- | :------- | :------------------------------------------------- |
28+
| teDeletionMode | string | false | Time entries deletion mode: 'delete' or 'unassign' |
29+
30+
### Response [​#](https://engineering.toggl.com/docs/api/projects/#response-10 "Direct link to Response")
31+
32+
#### 200 [​#](https://engineering.toggl.com/docs/api/projects/#200-10 "Direct link to 200")
33+
34+
Successful operation.
35+
36+
#### 400 [​#](https://engineering.toggl.com/docs/api/projects/#400-7 "Direct link to 400")
37+
38+
Possible errors:
39+
40+
- Invalid project_id
41+
42+
#### 403 [​#](https://engineering.toggl.com/docs/api/projects/#403-9 "Direct link to 403")
43+
44+
User does not have access to this resource.
45+
46+
#### 500 [​#](https://engineering.toggl.com/docs/api/projects/#500-10 "Direct link to 500")
47+
48+
Internal Server Error

‎spec/Projects/GET WorkspaceProjects.md

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
## GET WorkspaceProjects [​#](https://engineering.toggl.com/docs/api/projects/#get-workspaceprojects "Direct link to GET WorkspaceProjects")
2+
3+
```
4+
https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/projects
5+
```
6+
7+
Get projects for given workspace.
8+
9+
10+
```
11+
curl https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/projects \
12+
-H "Content-Type: application/json" \
13+
-u <email>:<password>
14+
```
15+
16+
### Parameters [​#](https://engineering.toggl.com/docs/api/projects/#parameters-5 "Direct link to Parameters")
17+
18+
#### Path [​#](https://engineering.toggl.com/docs/api/projects/#path-5 "Direct link to Path")
19+
20+
| name | type | required | description |
21+
| :----------- | :------ | :------- | :-------------------------- |
22+
| workspace_id | integer | true | Numeric ID of the workspace |
23+
24+
#### Query [​#](https://engineering.toggl.com/docs/api/projects/#query-2 "Direct link to Query")
25+
26+
| name | type | required | description |
27+
| :---------- | :------ | :------- | :--------------------------------------- |
28+
| sort_pinned | boolean | true | Place pinned projects at top of response |
29+
30+
#### Query [​#](https://engineering.toggl.com/docs/api/projects/#query-3 "Direct link to Query")
31+
32+
| name | type | required | description |
33+
| :------------- | :------ | :------- | :----------------------------------------------------------------------------------------------- |
34+
| active | boolean | false | Return active or inactive project. You can pass 'both' to get both active and inactive projects. |
35+
| since | integer | false | Retrieve projects created/modified/deleted since this date using UNIX timestamp. |
36+
| billable | boolean | false | billable |
37+
| user_ids | array | false | user_ids |
38+
| client_ids | array | false | client_ids |
39+
| group_ids | array | false | group_ids |
40+
| statuses | array | false | statuses |
41+
| name | string | true | name |
42+
| page | integer | true | page |
43+
| sort_field | string | true | sort_field |
44+
| sort_order | string | true | sort_order |
45+
| only_templates | boolean | true | only_templates |
46+
| only_me | boolean | false | get only projects assigned to the current user |
47+
| per_page | integer | false | Number of items per page, default 151. Cannot exceed 200. |
48+
49+
### Response [​#](https://engineering.toggl.com/docs/api/projects/#response-5 "Direct link to Response")
50+
51+
#### 200 [​#](https://engineering.toggl.com/docs/api/projects/#200-5 "Direct link to 200")
52+
53+
| Name | Type | Description |
54+
| ----- | --------------- | ----------- |
55+
| items | Array of object | \- |
56+
57+
##### items [​#](https://engineering.toggl.com/docs/api/projects/#items-1 "Direct link to items")
58+
59+
| Name | Type | Description |
60+
| -------------------- | --------------- | ----------------------------------------------------------------------------------------- |
61+
| active | boolean | Whether the project is active or archived |
62+
| actual_hours | integer | null |
63+
| actual_seconds | integer | null |
64+
| at | string | Last updated date |
65+
| auto_estimates | boolean | null |
66+
| billable | boolean | null |
67+
| can_track_time | boolean | \- |
68+
| cid | integer | Client ID legacy field |
69+
| client_id | integer | null |
70+
| client_name | string | \- |
71+
| color | string | Color |
72+
| created_at | string | Creation date |
73+
| currency | string | null |
74+
| current_period | object | Current project period, premium feature |
75+
| end_date | string | End date |
76+
| estimated_hours | integer | null |
77+
| estimated_seconds | integer | null |
78+
| external_reference | string | ExternalReference can be used to store an external reference to the Track Project Entity. |
79+
| fixed_fee | number | Fixed fee, premium feature |
80+
| id | integer | Project ID |
81+
| integration_ext_id | string | The external ID of the linked entity in the external system (e.g. JIRA/SalesForce) |
82+
| integration_ext_type | string | The external type of the linked entity in the external system (e.g. JIRA/SalesForce) |
83+
| integration_provider | string | The provider (e.g. JIRA/SalesForce) that has an entity linked to this Toggl Track entity |
84+
| is_private | boolean | Whether the project is private |
85+
| is_shared | boolean | Shared Project |
86+
| name | string | Name |
87+
| permissions | string | \- |
88+
| pinned | boolean | \- |
89+
| rate | number | Hourly rate |
90+
| rate_last_updated | string | null |
91+
| recurring | boolean | Whether the project is recurring, premium feature |
92+
| recurring_parameters | Array of object | Project recurring parameters, premium feature |
93+
| shared_at | string | \- |
94+
| shared_hash | string | \- |
95+
| start_date | string | Start date |
96+
| status | string | Status of the project (upcoming, active, ended, archived, deleted) |
97+
| tasks_count | integer | \- |
98+
| template | boolean | null |
99+
| template_id | integer | null |
100+
| wid | integer | Workspace ID legacy field |
101+
| workspace_id | integer | Workspace ID |
102+
103+
##### current_period [​#](https://engineering.toggl.com/docs/api/projects/#current_period "Direct link to current_period")
104+
105+
| Name | Type | Description |
106+
| ---------- | ------ | ----------- |
107+
| end_date | string | \- |
108+
| start_date | string | \- |
109+
110+
##### recurring_parameters [​#](https://engineering.toggl.com/docs/api/projects/#recurring_parameters "Direct link to recurring_parameters")
111+
112+
| Name | Type | Description |
113+
| -------------------- | ------- | --------------------------------------------------- |
114+
| custom_period | integer | Custom period, used when "period" field is "custom" |
115+
| estimated_seconds | integer | Estimated seconds |
116+
| parameter_end_date | string | null |
117+
| parameter_start_date | string | Recurring start date |
118+
| period | string | Period |
119+
| project_start_date | string | Project start date |
120+
121+
#### 403 [​#](https://engineering.toggl.com/docs/api/projects/#403-5 "Direct link to 403")
122+
123+
User does not have access to this resource.
124+
125+
#### 500 [​#](https://engineering.toggl.com/docs/api/projects/#500-5 "Direct link to 500")
126+
127+
Internal Server Error

0 commit comments

Comments
 (0)