Last active
March 13, 2021 23:02
-
-
Save ajayjohn/d8e0729e4d23319717de30282a057ecd to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| swagger: '2.0' | |
| info: {title: ClickUp 2.0, version: ''} | |
| host: api.clickup.com | |
| basePath: /api/v2 | |
| schemes: [https] | |
| paths: | |
| /task/{task_id}/attachment: | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {id: ac434d4e-8b1c-4571-951b-866b6d9f2ee6.png, version: '0', | |
| date: 1569988578766, title: image.png, extension: png, thumbnail_small: 'https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png', | |
| thumbnail_large: 'https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png', | |
| url: 'https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png'} | |
| summary: Post Task Attachment | |
| operationId: PostTaskAttachment | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hv, | |
| type: string} | |
| produces: [application/json] | |
| /oauth/token: | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {access_token: access token} | |
| summary: Get Access Token | |
| operationId: GetAccessToken | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: client_id, in: query, description: Oauth app client id, required: true, | |
| type: string} | |
| - {name: client_secret, in: query, description: Oauth app client secret, required: true, | |
| type: string} | |
| - {name: code, in: query, description: Code given in redirect url, required: true, | |
| type: string} | |
| produces: [application/json] | |
| /user: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| user: {id: 123, username: John Doe, color: '#000000', profilePicture: 'https://clickup.com/avatar.jpg'} | |
| summary: Get Authorized User | |
| operationId: GetAuthorizedUser | |
| description: '' | |
| tags: [] | |
| parameters: [] | |
| produces: [application/json] | |
| /team: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| teams: | |
| - id: '333' | |
| name: Team Name | |
| color: '#000000' | |
| avatar: null | |
| members: | |
| - user: {id: 812, username: John Doe, email: [email protected], color: '#FFFFFF', | |
| profilePicture: 'https://attachments-public.clickup.com/profilePictures/812_nx1.jpg', | |
| initials: JD, role: 2} | |
| - user: {id: 813, username: Jane Doe, email: [email protected], color: null, | |
| profilePicture: 'https://attachments-public.clickup.com/profilePictures/813_nx1.jpg', | |
| initials: JD, role: 3} | |
| summary: Get Teams | |
| operationId: GetTeams | |
| description: '' | |
| tags: [] | |
| parameters: [] | |
| produces: [application/json] | |
| /task/{task_id}/checklist: | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| checklist: | |
| id: b955c4dc-b8a8-48d8-a0c6-b4200788a683 | |
| task_id: 9hz | |
| name: Checklist | |
| orderindex: 0 | |
| resolved: 0 | |
| unresolved: 0 | |
| items: [] | |
| summary: Create Checklist | |
| operationId: CreateChecklist | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hz, | |
| type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| example: {name: Checklist} | |
| produces: [application/json] | |
| /checklist/{checklist_id}: | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Delete Checklist | |
| operationId: DeleteChecklist | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: checklist_id, in: path, description: b8a8-48d8-a0c6-b4200788a683 (uuid), | |
| required: true, x-example: b955c4dc, type: string} | |
| produces: [application/json] | |
| put: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: {} | |
| summary: Edit Checklist | |
| operationId: EditChecklist | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: checklist_id, in: path, description: b8a8-48d8-a0c6-b4200788a683 (uuid), | |
| required: true, x-example: b955c4dc, type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| position: {type: number} | |
| example: {name: Updated Checklist, position: 1} | |
| /checklist/{checklist_id}/checklist_item: | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| checklist: | |
| id: b955c4dc-b8a8-48d8-a0c6-b4200788a683 | |
| task_id: 9hv | |
| name: Checklist | |
| date_created: '1567711563204' | |
| orderindex: 0 | |
| resolved: 0 | |
| unresolved: 1 | |
| items: | |
| - id: 21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f | |
| name: Checklist Item | |
| orderindex: 0 | |
| assignee: {id: 183, username: John Doe, email: [email protected], | |
| color: '#827718', initials: JK, profilePicture: 'https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg'} | |
| resolved: false | |
| parent: null | |
| date_created: '1567711566859' | |
| children: [] | |
| summary: Create Checklist Item | |
| operationId: CreateChecklistItem | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: checklist_id, in: path, description: b8a8-48d8-a0c6-b4200788a683 (uuid), | |
| required: true, x-example: b955c4dc, type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| assignee: {type: number} | |
| example: {name: Checklist Item, assignee: 183} | |
| produces: [application/json] | |
| /checklist/{checklist_id}/checklist_item/{checklist_item_id}: | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Delete Checklist Item | |
| operationId: DeleteChecklistItem | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: checklist_id, in: path, description: b8a8-48d8-a0c6-b4200788a683 (uuid), | |
| required: true, x-example: b955c4dc, type: string} | |
| - {name: checklist_item_id, in: path, description: e491-47f5-9fd8-d1dc4cedcc6f | |
| (uuid), required: true, x-example: 21e08dc8, type: string} | |
| produces: [application/json] | |
| put: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| checklist: | |
| id: b955c4dc-b8a8-48d8-a0c6-b4200788a683 | |
| task_id: 9hv | |
| name: Checklist | |
| date_created: '1567711563204' | |
| orderindex: 0 | |
| resolved: 1 | |
| unresolved: 0 | |
| items: | |
| - id: 21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f | |
| name: Updated Checklist Item | |
| orderindex: 0 | |
| assignee: null | |
| resolved: true | |
| parent: null | |
| date_created: '1567711566859' | |
| children: [] | |
| summary: Edit Checklist Item | |
| operationId: EditChecklistItem | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: checklist_id, in: path, description: b8a8-48d8-a0c6-b4200788a683 (uuid), | |
| required: true, x-example: b955c4dc, type: string} | |
| - {name: checklist_item_id, in: path, description: e491-47f5-9fd8-d1dc4cedcc6f | |
| (uuid), required: true, x-example: 21e08dc8, type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| assignee: {type: integer, format: int32} | |
| resolved: {type: boolean} | |
| parent: {type: string} | |
| example: {name: Updated Checklist Item, assignee: null, resolved: true, | |
| parent: null} | |
| produces: [application/json] | |
| /task/{task_id}/comment: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| comments: | |
| - id: '458' | |
| comment: | |
| - {text: Task comment content} | |
| comment_text: Task comment content | |
| user: {id: 183, username: John Doe, initials: JD, email: [email protected], | |
| color: '#827718', profilePicture: 'https://attachments-public.clickup.com/profilePictures/183_abc.jpg'} | |
| resolved: false | |
| assignee: {id: 183, username: John Doe, initials: JD, email: [email protected], | |
| color: '#827718', profilePicture: 'https://attachments-public.clickup.com/profilePictures/183_abc.jpg'} | |
| assigned_by: {id: 183, username: John Doe, initials: JD, email: [email protected], | |
| color: '#827718', profilePicture: 'https://attachments-public.clickup.com/profilePictures/183_abc.jpg'} | |
| reactions: [] | |
| date: '1568036964079' | |
| summary: Get Task Comments | |
| operationId: GetTaskComments | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hz, | |
| type: string} | |
| produces: [application/json] | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {id: '458', hist_id: '26508', date: 1568036964079} | |
| summary: Post Task Comment | |
| operationId: PostTaskComment | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hz, | |
| type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| comment_text: {type: string} | |
| assignee: {type: number} | |
| notify_all: {type: boolean} | |
| example: {comment_text: Task comment content, assignee: 183, notify_all: true} | |
| produces: [application/json] | |
| /view/{view_id}/comment: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| comments: | |
| - id: '459' | |
| comment: | |
| - {text: View comment content} | |
| comment_text: View comment content | |
| user: {id: 183, username: John Doe, initials: JD, email: [email protected], | |
| color: '#827718', profilePicture: 'https://attachments-public.clickup.com/profilePictures/183_abc.jpg'} | |
| resolved: false | |
| assignee: null | |
| assigned_by: null | |
| reactions: [] | |
| date: '1568036964079' | |
| summary: Get View Comments | |
| operationId: GetViewComments | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: view_id, in: path, description: 105 (string), required: true, x-example: 3c, | |
| type: string} | |
| produces: [application/json] | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {id: '459', hist_id: 0a45e16e-4e2f-4a9e-99ec-3cf520b87eae, | |
| date: 1568037065216} | |
| summary: Post View Comment | |
| operationId: PostViewComment | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: view_id, in: path, description: 105 (string), required: true, x-example: 3c, | |
| type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| comment_text: {type: string} | |
| notify_all: {type: boolean} | |
| example: {comment_text: View comment content, notify_all: true} | |
| produces: [application/json] | |
| /list/{list_id}/comment: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| comments: | |
| - id: '462' | |
| comment: | |
| - {text: List comment content} | |
| comment_text: List comment content | |
| user: {id: 183, username: John Doe, initials: JD, email: [email protected], | |
| color: '#827718', profilePicture: 'https://attachments-public.clickup.com/profilePictures/183_abc.jpg'} | |
| resolved: false | |
| assignee: {id: 183, username: John Doe, initials: JD, email: [email protected], | |
| color: '#827718', profilePicture: 'https://attachments-public.clickup.com/profilePictures/183_abc.jpg'} | |
| assigned_by: {id: 183, username: John Doe, initials: JD, email: [email protected], | |
| color: '#827718', profilePicture: 'https://attachments-public.clickup.com/profilePictures/183_abc.jpg'} | |
| reactions: [] | |
| date: '1568036964079' | |
| summary: Get List Comments | |
| operationId: GetListComments | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: list_id, in: path, description: '', required: true, x-example: '124', | |
| type: number} | |
| produces: [application/json] | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {id: '462', hist_id: 5bbea9ad-7cc3-4038-a8bb-a89ac1337c08, | |
| date: 1568037341249} | |
| summary: Post List Comment | |
| operationId: PostListComment | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: list_id, in: path, description: '', required: true, x-example: '124', | |
| type: number} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| comment_text: {type: string} | |
| assignee: {type: number} | |
| notify_all: {type: boolean} | |
| example: {comment_text: List comment content, assignee: 183, notify_all: true} | |
| produces: [application/json] | |
| /comment/{comment_id}: | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Delete Comment | |
| operationId: DeleteComment | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: comment_id, in: path, description: '', required: true, x-example: '456', | |
| type: number} | |
| produces: [application/json] | |
| put: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Update Comment | |
| operationId: UpdateComment | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: comment_id, in: path, description: '', required: true, x-example: '456', | |
| type: number} | |
| produces: [application/json] | |
| /list/{list_id}/field: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| fields: | |
| - id: 03efda77-c7a0-42d3-8afd-fd546353c2f5 | |
| name: Text Field | |
| type: text | |
| type_config: {} | |
| date_created: '1566400407303' | |
| hide_from_guests: false | |
| - id: 0a52c486-5f05-403b-b4fd-c512ff05131c | |
| name: Number Field | |
| type: number | |
| type_config: {} | |
| date_created: '1565993269460' | |
| hide_from_guests: false | |
| - id: 0c7e8f5c-557b-4128-bf37-29e2fe5bb7f9 | |
| name: Label Field | |
| type: labels | |
| type_config: | |
| options: | |
| - {id: fb332c98-d7bc-4ee8-a3bd-b5ffaff98c3c, label: one, color: null} | |
| - {id: 2b0c058c-2f41-4f61-8fc8-f9ea426e8c0e, label: two, color: null} | |
| - {id: 75e10f4b-b4cc-4ef9-94dc-230d19ef4fa6, label: three, color: null} | |
| date_created: '1558567802303' | |
| hide_from_guests: false | |
| - id: 10916331-1903-4026-886f-891f29aa9fb6 | |
| name: Checkbox Field | |
| type: checkbox | |
| type_config: {} | |
| date_created: '1562944066529' | |
| hide_from_guests: false | |
| - id: 2e3d4145-9a54-4d0a-9446-78ba595b327f | |
| name: Date Field | |
| type: date | |
| type_config: {} | |
| date_created: '1565886951888' | |
| hide_from_guests: false | |
| - id: 31b84286-635a-45fd-bbd5-3814fbbb08bb | |
| name: User Field | |
| type: users | |
| type_config: {} | |
| date_created: '1565962775482' | |
| hide_from_guests: false | |
| - id: 5cf8a44f-4421-4982-97d7-3e2209be2df4 | |
| name: Currency Field | |
| type: currency | |
| type_config: {default: null, precision: 2, currency_type: USD} | |
| date_created: '1565993263347' | |
| hide_from_guests: false | |
| - id: 790e5051-7923-43e8-8f05-2e4940557bd8 | |
| name: Phone Field | |
| type: phone | |
| type_config: {} | |
| date_created: '1563545189836' | |
| hide_from_guests: false | |
| - id: 8551901a-3eca-4193-b691-e0e3c9f94ff3 | |
| name: Drop Down Field | |
| type: drop_down | |
| type_config: | |
| default: 0 | |
| placeholder: null | |
| options: | |
| - {id: 5f6ce650-cb1d-437d-8373-72578a092510, name: '1', value: 1, | |
| type: numeric, orderindex: 0, color: null} | |
| - {id: 89707879-c4e1-44b9-9cc0-be7c16ee6681, name: '2', value: 2, | |
| type: numeric, orderindex: 1, color: null} | |
| date_created: '1565993237778' | |
| hide_from_guests: false | |
| - id: 9b45e079-f647-4556-bdd9-a7589ccd2530 | |
| name: Manual Progress Field | |
| type: manual_progress | |
| type_config: {end: 100, start: 0} | |
| date_created: '1565993299379' | |
| hide_from_guests: false | |
| - id: b5be3c35-4fe1-429e-affe-4318de213efe | |
| name: Emoji (Rating) Field | |
| type: emoji | |
| type_config: {count: 5, code_point: 1f383} | |
| date_created: '1565993309955' | |
| hide_from_guests: false | |
| - id: ba0d56f6-f1ba-4015-b726-12c013bb8ac6 | |
| name: Automatic Progress Field | |
| type: automatic_progress | |
| type_config: | |
| tracking: {subtasks: true, checklists: true, assigned_comments: true} | |
| complete_on: 3 | |
| date_created: '1566405066706' | |
| hide_from_guests: false | |
| - id: decb4a8a-6120-46b0-9cbb-66f3ee1de3c5 | |
| name: Email Field | |
| type: email | |
| type_config: {} | |
| date_created: '1565993242649' | |
| hide_from_guests: false | |
| - id: e438e267-4f9f-4b54-b937-cbdb0e0369dd | |
| name: URL Field | |
| type: url | |
| type_config: {} | |
| date_created: '1559001282914' | |
| hide_from_guests: false | |
| summary: Get Accessible Custom Fields | |
| operationId: GetAccessibleCustomFields | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: list_id, in: path, description: '', required: true, x-example: '123', | |
| type: number} | |
| produces: [application/json] | |
| /task/{task_id}/field/{field_id}: | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Remove Custom Field Value | |
| operationId: RemoveCustomFieldValue | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hv, | |
| type: string} | |
| - {name: field_id, in: path, description: b8a8-48d8-a0c6-b4200788a683 (uuid), | |
| required: true, x-example: b955c4dc, type: string} | |
| produces: [application/json] | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Set Custom Field Value | |
| operationId: SetCustomFieldValue | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hv, | |
| type: string} | |
| - {name: field_id, in: path, description: b8a8-48d8-a0c6-b4200788a683 (uuid), | |
| required: true, x-example: b955c4dc, type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| value: {type: number} | |
| example: {value: 80} | |
| produces: [application/json] | |
| /task/{task_id}/dependency: | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Delete Dependency | |
| operationId: DeleteDependency | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hv, | |
| type: string} | |
| - {name: depends_on, in: query, description: '', required: true, x-example: 9hz, | |
| type: string} | |
| - {name: dependency_of, in: query, description: '', required: true, x-example: 9hz, | |
| type: string} | |
| produces: [application/json] | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Add Dependency | |
| operationId: AddDependency | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hv, | |
| type: string} | |
| produces: [application/json] | |
| /space/{space_id}/folder: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| - id: '457' | |
| name: Updated Folder Name | |
| orderindex: 0 | |
| override_statuses: false | |
| hidden: false | |
| space: {id: '789', name: Space Name, access: true} | |
| task_count: '0' | |
| lists: [] | |
| - id: '458' | |
| name: Second Folder Name | |
| orderindex: 1 | |
| override_statuses: false | |
| hidden: false | |
| space: {id: '789', name: Space Name, access: true} | |
| task_count: '0' | |
| lists: [] | |
| summary: Get Folders | |
| operationId: GetFolders | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: space_id, in: path, description: '', required: true, x-example: '789', | |
| type: number} | |
| - {name: archived, in: query, description: '', required: true, x-example: 'false', | |
| type: boolean} | |
| produces: [application/json] | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| id: '457' | |
| name: New Folder Name | |
| orderindex: 0 | |
| override_statuses: false | |
| hidden: false | |
| space: {id: '789', name: Space Name, access: true} | |
| task_count: '0' | |
| summary: Create Folder | |
| operationId: CreateFolder | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: space_id, in: path, description: '', required: true, x-example: '789', | |
| type: number} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| example: {name: New Folder Name} | |
| produces: [application/json] | |
| /folder/{folder_id}: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| id: '457' | |
| name: Updated Folder Name | |
| orderindex: 0 | |
| override_statuses: false | |
| hidden: false | |
| space: {id: '789', name: Space Name, access: true} | |
| task_count: '0' | |
| lists: [] | |
| summary: Get Folder | |
| operationId: GetFolder | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: folder_id, in: path, description: '', required: true, x-example: '457', | |
| type: number} | |
| produces: [application/json] | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Delete Folder | |
| operationId: DeleteFolder | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: folder_id, in: path, description: '', required: true, x-example: '457', | |
| type: number} | |
| produces: [application/json] | |
| put: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| id: '457' | |
| name: Updated Folder Name | |
| orderindex: 0 | |
| override_statuses: false | |
| hidden: false | |
| space: {id: '789', name: Space Name, access: true} | |
| task_count: '0' | |
| summary: Update Folder | |
| operationId: UpdateFolder | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: folder_id, in: path, description: '', required: true, x-example: '457', | |
| type: number} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| example: {name: Updated Folder Name} | |
| produces: [application/json] | |
| /team/{team_id}/goal: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| goals: | |
| - id: e53a033c-900e-462d-a849-4a216b06d930 | |
| name: Updated Goal Name | |
| team_id: '512' | |
| date_created: '1568044355026' | |
| start_date: null | |
| due_date: '1568036964079' | |
| description: Updated Goal Description | |
| private: false | |
| archived: false | |
| creator: 183 | |
| color: '#32a852' | |
| pretty_id: '6' | |
| multiple_owners: true | |
| folder_id: null | |
| members: [] | |
| owners: | |
| - {id: 182, username: Jane Doe, initials: JD, email: [email protected], | |
| color: '#827718', profilePicture: 'https://attachments-public.clickup.com/profilePictures/182_abc.jpg'} | |
| key_results: [] | |
| percent_completed: 0 | |
| history: [] | |
| pretty_url: https://app.clickup.com/512/goals/6 | |
| folders: | |
| - id: 05921253-7737-44af-a1aa-36fd11244e6f | |
| name: Goal Folder | |
| team_id: '512' | |
| private: true | |
| date_created: '1548802674671' | |
| creator: 182 | |
| goal_count: 0 | |
| members: | |
| - {id: 182, username: Jane Doe, initials: JD, email: [email protected], | |
| color: '#827718', profilePicture: 'https://attachments-public.clickup.com/profilePictures/182_abc.jpg'} | |
| goals: [] | |
| summary: Get Goals | |
| operationId: GetGoals | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: team_id, in: path, description: '', required: true, x-example: '512', | |
| type: number} | |
| produces: [application/json] | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| goal: | |
| id: e53a033c-900e-462d-a849-4a216b06d930 | |
| name: Goal Name | |
| team_id: '512' | |
| date_created: '1568044355026' | |
| start_date: null | |
| due_date: '1568036964079' | |
| description: Goal Description | |
| private: false | |
| archived: false | |
| creator: 183 | |
| color: '#32a852' | |
| pretty_id: '6' | |
| multiple_owners: true | |
| folder_id: null | |
| members: [] | |
| owners: | |
| - {id: 183, username: John Doe, initials: JD, email: [email protected], | |
| color: '#827718', profilePicture: 'https://attachments-public.clickup.com/profilePictures/183_abc.jpg'} | |
| key_results: [] | |
| percent_completed: 0 | |
| history: [] | |
| pretty_url: https://app.clickup.com/512/goals/6 | |
| summary: Create Goal | |
| operationId: CreateGoal | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: team_id, in: path, description: '', required: true, x-example: '512', | |
| type: number} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| due_date: {type: number} | |
| description: {type: string} | |
| multiple_owners: {type: boolean} | |
| owners: | |
| type: array | |
| items: {type: number} | |
| color: {type: string} | |
| example: | |
| name: Goal Name | |
| due_date: 1568036964079 | |
| description: Goal Description | |
| multiple_owners: true | |
| owners: [183] | |
| color: '#32a852' | |
| produces: [application/json] | |
| /goal/{goal_id}: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| goal: | |
| id: e53a033c-900e-462d-a849-4a216b06d930 | |
| name: Updated Goal Name | |
| team_id: '512' | |
| date_created: '1568044355026' | |
| start_date: null | |
| due_date: '1568036964079' | |
| description: Updated Goal Description | |
| private: false | |
| archived: false | |
| creator: 183 | |
| color: '#32a852' | |
| pretty_id: '6' | |
| multiple_owners: true | |
| folder_id: null | |
| members: [] | |
| owners: | |
| - {id: 182, username: Jane Doe, initials: JD, email: [email protected], | |
| color: '#827718', profilePicture: 'https://attachments-public.clickup.com/profilePictures/182_abc.jpg'} | |
| key_results: [] | |
| percent_completed: 0 | |
| history: [] | |
| pretty_url: https://app.clickup.com/512/goals/6 | |
| summary: Get Goal | |
| operationId: GetGoal | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: goal_id, in: path, description: 900e-462d-a849-4a216b06d930 (uuid), | |
| required: true, x-example: e53a033c, type: string} | |
| produces: [application/json] | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Delete Goal | |
| operationId: DeleteGoal | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: goal_id, in: path, description: 900e-462d-a849-4a216b06d930 (uuid), | |
| required: true, x-example: e53a033c, type: string} | |
| produces: [application/json] | |
| put: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| goal: | |
| id: e53a033c-900e-462d-a849-4a216b06d930 | |
| name: Updated Goal Name | |
| team_id: '512' | |
| date_created: '1568044355026' | |
| start_date: null | |
| due_date: '1568036964079' | |
| description: Updated Goal Description | |
| private: false | |
| archived: false | |
| creator: 183 | |
| color: '#32a852' | |
| pretty_id: '6' | |
| multiple_owners: true | |
| folder_id: null | |
| members: [] | |
| owners: | |
| - {id: 182, username: Jane Doe, initials: JD, email: [email protected], | |
| color: '#827718', profilePicture: 'https://attachments-public.clickup.com/profilePictures/182_abc.jpg'} | |
| key_results: [] | |
| percent_completed: 0 | |
| history: [] | |
| pretty_url: https://app.clickup.com/512/goals/6 | |
| summary: Update Goal | |
| operationId: UpdateGoal | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: goal_id, in: path, description: 900e-462d-a849-4a216b06d930 (uuid), | |
| required: true, x-example: e53a033c, type: string} | |
| produces: [application/json] | |
| /goal/{goal_id}/key_result: | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| key_result: | |
| id: 947d46ed-8480-49bc-8c57-e569747efe93 | |
| goal_id: e53a033c-900e-462d-a849-4a216b06d930 | |
| name: New Key Result Name | |
| type: number | |
| unit: km | |
| creator: 183 | |
| date_created: '1568062902048' | |
| goal_pretty_id: '6' | |
| percent_completed: null | |
| completed: false | |
| task_ids: [] | |
| subcategory_ids: [] | |
| owners: | |
| - {id: 183, username: John Doe, email: [email protected], color: '#827718', | |
| profilePicture: 'https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg', | |
| initials: JK} | |
| last_action: {id: d3183d0f-5cbd-4158-b015-71465f1df269, key_result_id: 947d46ed-8480-49bc-8c57-e569747efe93, | |
| userid: 183, date_modified: '1568062902048', steps_taken: null, | |
| note: Created Key Result, steps_before: null, steps_current: null} | |
| summary: Create Key Result | |
| operationId: CreateKeyResult | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: goal_id, in: path, description: 900e-462d-a849-4a216b06d930 (uuid), | |
| required: true, x-example: e53a033c, type: string} | |
| - {name: Authoriation, in: header, description: e.g. "access_token", required: false, | |
| x-example: '"access_token"', type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| owners: | |
| type: array | |
| items: {type: number} | |
| type: {type: string} | |
| steps_start: {type: number} | |
| steps_end: {type: number} | |
| unit: {type: string} | |
| task_ids: | |
| type: array | |
| items: {} | |
| list_ids: | |
| type: array | |
| items: {} | |
| example: | |
| name: New Key Result Name | |
| owners: [183] | |
| type: number | |
| steps_start: 0 | |
| steps_end: 10 | |
| unit: km | |
| task_ids: [] | |
| list_ids: [] | |
| produces: [application/json] | |
| /key_result/{key_result_id}: | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Delete Key Result | |
| operationId: DeleteKeyResult | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: key_result_id, in: path, description: 8480-49bc-8c57-e569747efe93 (uuid), | |
| required: true, x-example: 947d46ed, type: string} | |
| produces: [application/json] | |
| put: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| key_result: | |
| id: 947d46ed-8480-49bc-8c57-e569747efe93 | |
| goal_id: e53a033c-900e-462d-a849-4a216b06d930 | |
| name: New Key Result Name | |
| type: number | |
| unit: km | |
| creator: 183 | |
| date_created: '1568062902048' | |
| goal_pretty_id: '6' | |
| percent_completed: null | |
| completed: false | |
| task_ids: [] | |
| subcategory_ids: [] | |
| owners: | |
| - {id: 183, username: John Doe, email: [email protected], color: '#827718', | |
| profilePicture: 'https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg', | |
| initials: JK} | |
| last_action: {id: e889858b-a023-46cc-968a-cac32fd04c1e, key_result_id: 19c7a55e-537e-4bc9-b741-08df05a5bda8, | |
| userid: 183, date_modified: '1568122776851', steps_taken: null, | |
| note: Target achieved, steps_before: null, steps_current: null, | |
| steps_before_float: 0, steps_taken_float: 5, steps_current_float: null} | |
| summary: Edit Key Result | |
| operationId: EditKeyResult | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: key_result_id, in: path, description: 8480-49bc-8c57-e569747efe93 (uuid), | |
| required: true, x-example: 947d46ed, type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| steps_current: {type: number} | |
| note: {type: string} | |
| example: {steps_current: 5, note: Target achieved} | |
| produces: [application/json] | |
| /folder/{folder_id}/list: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| lists: | |
| - id: '124' | |
| name: Updated List Name | |
| orderindex: 1 | |
| content: Updated List Content | |
| status: {status: red, color: '#e50000', hide_label: true} | |
| priority: {priority: high, color: '#f50000'} | |
| assignee: null | |
| task_count: null | |
| due_date: '1567780450202' | |
| due_date_time: true | |
| start_date: null | |
| start_date_time: null | |
| folder: {id: '456', name: Folder Name, hidden: false, access: true} | |
| space: {id: '789', name: Space Name, access: true} | |
| inbound_address: add.task.124.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com | |
| - id: '125' | |
| name: Second List | |
| orderindex: 1 | |
| content: Second List Content | |
| status: null | |
| priority: null | |
| assignee: null | |
| task_count: null | |
| due_date: null | |
| due_date_time: null | |
| start_date: null | |
| start_date_time: null | |
| folder: {id: '456', name: Folder Name, hidden: false, access: true} | |
| space: {id: '789', name: Space Name, access: true} | |
| inbound_address: add.task.125.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com | |
| summary: Get Lists | |
| operationId: GetLists | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: folder_id, in: path, description: '', required: true, x-example: '456', | |
| type: number} | |
| - {name: archived, in: query, description: '', required: true, x-example: 'false', | |
| type: boolean} | |
| produces: [application/json] | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| id: '124' | |
| name: New List Name | |
| orderindex: 1 | |
| content: New List Content | |
| status: {status: red, color: '#e50000', hide_label: true} | |
| priority: {priority: urgent, color: '#f50000'} | |
| assignee: {id: 183, color: '#827718', username: Jerry Krusinski, initials: JK, | |
| profilePicture: 'https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg'} | |
| task_count: null | |
| due_date: '1567780450202' | |
| due_date_time: false | |
| start_date: null | |
| start_date_time: null | |
| folder: {id: '456', name: Folder Name, hidden: false, access: true} | |
| space: {id: '789', name: Space Name, access: true} | |
| inbound_address: add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com | |
| summary: Create List | |
| operationId: CreateList | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: folder_id, in: path, description: '', required: true, x-example: '456', | |
| type: number} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| content: {type: string} | |
| due_date: {type: number} | |
| due_date_time: {type: boolean} | |
| priority: {type: number} | |
| assignee: {type: number} | |
| status: {type: string} | |
| example: {name: New List Name, content: New List Content, due_date: 1567780450202, | |
| due_date_time: false, priority: 1, assignee: 183, status: red} | |
| produces: [application/json] | |
| /space/{space_id}/list: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| lists: | |
| - id: '124' | |
| name: Updated List Name | |
| orderindex: 1 | |
| content: Updated List Content | |
| status: {status: red, color: '#e50000', hide_label: true} | |
| priority: {priority: high, color: '#f50000'} | |
| assignee: null | |
| task_count: null | |
| due_date: '1567780450202' | |
| due_date_time: true | |
| start_date: null | |
| start_date_time: null | |
| folder: {id: '457', name: hidden, hidden: true, access: true} | |
| space: {id: '789', name: Space Name, access: true} | |
| inbound_address: add.task.124.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com | |
| - id: '125' | |
| name: Second List | |
| orderindex: 1 | |
| content: Second List Content | |
| status: null | |
| priority: null | |
| assignee: null | |
| task_count: null | |
| due_date: null | |
| due_date_time: null | |
| start_date: null | |
| start_date_time: null | |
| folder: {id: '457', name: hidden, hidden: true, access: true} | |
| space: {id: '789', name: Space Name, access: true} | |
| inbound_address: add.task.125.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com | |
| summary: Get Folderless Lists | |
| operationId: GetFolderlessLists | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: space_id, in: path, description: '', required: true, x-example: '789', | |
| type: number} | |
| - {name: archived, in: query, description: '', required: true, x-example: 'false', | |
| type: boolean} | |
| produces: [application/json] | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| id: '124' | |
| name: New List Name | |
| orderindex: 1 | |
| content: New List Content | |
| status: {status: red, color: '#e50000', hide_label: true} | |
| priority: {priority: urgent, color: '#f50000'} | |
| assignee: {id: 183, color: '#827718', username: Jerry Krusinski, initials: JK, | |
| profilePicture: 'https://dev-attachments-public.clickup.com/profilePictures/183_nx1.jpg'} | |
| task_count: null | |
| due_date: '1567780450202' | |
| due_date_time: false | |
| start_date: null | |
| start_date_time: null | |
| folder: {id: '457', name: hidden, hidden: true, access: true} | |
| space: {id: '789', name: Space Name, access: true} | |
| inbound_address: add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com | |
| summary: Create Folderless List | |
| operationId: CreateFolderlessList | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: space_id, in: path, description: '', required: true, x-example: '789', | |
| type: number} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| content: {type: string} | |
| due_date: {type: number} | |
| due_date_time: {type: boolean} | |
| priority: {type: number} | |
| assignee: {type: number} | |
| status: {type: string} | |
| example: {name: New List Name, content: New List Content, due_date: 1567780450202, | |
| due_date_time: false, priority: 1, assignee: 183, status: red} | |
| produces: [application/json] | |
| /list/{list_id}: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: {applicaton/json: " {\n \"id\": \"124\",\n \"\ | |
| name\": \"Updated List Name\",\n \"orderindex\": 1,\n \ | |
| \ \"content\": \"Updated List Content\",\n \"status\": {\n \ | |
| \ \"status\": \"red\",\n \"color\": \"#e50000\"\ | |
| ,\n \"hide_label\": true\n },\n \"priority\"\ | |
| : {\n \"priority\": \"high\",\n \"color\": \"\ | |
| #f50000\"\n },\n \"assignee\": null,\n \"task_count\"\ | |
| : null,\n \"due_date\": \"1567780450202\",\n \"due_date_time\"\ | |
| : true,\n \"start_date\": null,\n \"start_date_time\"\ | |
| : null,\n \"folder\": {\n \"id\": \"456\",\n \ | |
| \ \"name\": \"Folder Name\",\n \"hidden\": false,\n\ | |
| \ \"access\": true\n },\n \"space\": {\n \ | |
| \ \"id\": \"789\",\n \"name\": \"Space Name\",\n\ | |
| \ \"access\": true\n },\n \"inbound_address\"\ | |
| : \"add.task.124.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com\"\ | |
| \n }\n"} | |
| summary: Get List | |
| operationId: GetList | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: list_id, in: path, description: '', required: true, x-example: '124', | |
| type: number} | |
| produces: [applicaton/json] | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Delete List | |
| operationId: DeleteList | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: list_id, in: path, description: '', required: true, x-example: '124', | |
| type: number} | |
| produces: [application/json] | |
| put: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| id: '124' | |
| name: Updated List Name | |
| orderindex: 1 | |
| content: Updated List Content | |
| status: {status: red, color: '#e50000', hide_label: true} | |
| priority: {priority: high, color: '#f50000'} | |
| assignee: null | |
| task_count: null | |
| due_date: '1567780450202' | |
| due_date_time: true | |
| start_date: null | |
| start_date_time: null | |
| folder: {id: '456', name: Folder Name, hidden: false, access: true} | |
| space: {id: '789', name: Space Name, access: true} | |
| inbound_address: add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com | |
| summary: Update List | |
| operationId: UpdateList | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: list_id, in: path, description: '', required: true, x-example: '124', | |
| type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| content: {type: string} | |
| due_date: {type: number} | |
| due_date_time: {type: boolean} | |
| priority: {type: number} | |
| assignee: {type: string} | |
| unset_status: {type: boolean} | |
| example: {name: Updated List Name, content: Updated List Content, due_date: 1567780450202, | |
| due_date_time: true, priority: 2, assignee: none, unset_status: true} | |
| produces: [application/json] | |
| /task/{task_id}/member: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| members: | |
| - {id: 812, username: John Doe, email: [email protected], color: '#FFFFFF', | |
| profilePicture: 'https://attachments-public.clickup.com/profilePictures/812_nx1.jpg', | |
| initials: JD, role: 2} | |
| - {id: 813, username: Jane Doe, email: [email protected], color: null, | |
| profilePicture: 'https://attachments-public.clickup.com/profilePictures/813_nx1.jpg', | |
| initials: JD, role: 3} | |
| summary: Get Task Members | |
| operationId: GetTaskMembers | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hz, | |
| type: string} | |
| produces: [application/json] | |
| /list/{list_id}/member: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| members: | |
| - {id: 812, username: John Doe, email: [email protected], color: '#FFFFFF', | |
| profilePicture: 'https://attachments-public.clickup.com/profilePictures/812_nx1.jpg', | |
| initials: JD, role: 2} | |
| - {id: 813, username: Jane Doe, email: [email protected], color: null, | |
| profilePicture: 'https://attachments-public.clickup.com/profilePictures/813_nx1.jpg', | |
| initials: JD, role: 3} | |
| summary: Get List Members | |
| operationId: GetListMembers | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: list_id, in: path, description: '', required: true, x-example: '123', | |
| type: number} | |
| produces: [application/json] | |
| /team/{team_id}/share: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| shared: | |
| tasks: [] | |
| lists: | |
| - {id: '1421', name: Shared List, orderindex: 0, content: null, status: null, | |
| priority: null, assignee: null, task_count: '0', due_date: null, | |
| start_date: null, archived: false} | |
| folders: | |
| - {id: '1058', name: Shared Folder, orderindex: 0, content: null, | |
| task_count: '0', due_date: null, archived: false} | |
| summary: Shared Hierarchy | |
| operationId: SharedHierarchy | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: team_id, in: path, description: '', required: true, x-example: '333', | |
| type: number} | |
| produces: [application/json] | |
| /team/{team_id}/space: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| spaces: | |
| - id: '790' | |
| name: Updated Space Name | |
| private: false | |
| statuses: | |
| - {status: to do, type: open, orderindex: 0, color: '#d3d3d3'} | |
| - {status: complete, type: closed, orderindex: 1, color: '#6bc950'} | |
| multiple_assignees: false | |
| features: | |
| due_dates: {enabled: false, start_date: false, remap_due_dates: false, | |
| remap_closed_due_date: false} | |
| time_tracking: {enabled: false} | |
| tags: {enabled: false} | |
| time_estimates: {enabled: false} | |
| checklists: {enabled: true} | |
| custom_fields: {enabled: true} | |
| remap_dependencies: {enabled: false} | |
| dependency_warning: {enabled: false} | |
| portfolios: {enabled: false} | |
| - id: '791' | |
| name: Second Space Name | |
| private: false | |
| statuses: | |
| - {status: Open, type: open, orderindex: 0, color: '#d3d3d3'} | |
| - {status: Closed, type: closed, orderindex: 1, color: '#6bc950'} | |
| multiple_assignees: true | |
| features: | |
| due_dates: {enabled: true, start_date: false, remap_due_dates: false, | |
| remap_closed_due_date: false} | |
| time_tracking: {enabled: true} | |
| tags: {enabled: true} | |
| time_estimates: {enabled: true} | |
| checklists: {enabled: true} | |
| summary: Get Spaces | |
| operationId: GetSpaces | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: team_id, in: path, description: '', required: true, x-example: '512', | |
| type: number} | |
| - {name: archived, in: query, description: '', required: true, x-example: 'false', | |
| type: boolean} | |
| produces: [application/json] | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| id: '790' | |
| name: New Space Name | |
| private: false | |
| statuses: | |
| - {status: to do, type: open, orderindex: 0, color: '#d3d3d3'} | |
| - {status: complete, type: closed, orderindex: 1, color: '#6bc950'} | |
| multiple_assignees: true | |
| features: | |
| due_dates: {enabled: true, start_date: false, remap_due_dates: true, | |
| remap_closed_due_date: false} | |
| time_tracking: {enabled: false} | |
| tags: {enabled: true} | |
| time_estimates: {enabled: true} | |
| checklists: {enabled: true} | |
| custom_fields: {enabled: true} | |
| remap_dependencies: {enabled: true} | |
| dependency_warning: {enabled: true} | |
| portfolios: {enabled: true} | |
| summary: Create Space | |
| operationId: CreateSpace | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: team_id, in: path, description: '', required: true, x-example: '512', | |
| type: number} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| multiple_assignees: {type: boolean} | |
| features: | |
| type: object | |
| properties: | |
| due_dates: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| start_date: {type: boolean} | |
| remap_due_dates: {type: boolean} | |
| remap_closed_due_date: {type: boolean} | |
| time_tracking: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| tags: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| time_estimates: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| checklists: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| custom_fields: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| remap_dependencies: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| dependency_warning: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| portfolios: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| example: | |
| name: New Space Name | |
| multiple_assignees: true | |
| features: | |
| due_dates: {enabled: true, start_date: false, remap_due_dates: true, | |
| remap_closed_due_date: false} | |
| time_tracking: {enabled: false} | |
| tags: {enabled: true} | |
| time_estimates: {enabled: true} | |
| checklists: {enabled: true} | |
| custom_fields: {enabled: true} | |
| remap_dependencies: {enabled: true} | |
| dependency_warning: {enabled: true} | |
| portfolios: {enabled: true} | |
| produces: [application/json] | |
| /space/{space_id}: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| id: '790' | |
| name: Updated Space Name | |
| private: false | |
| statuses: | |
| - {status: to do, type: open, orderindex: 0, color: '#d3d3d3'} | |
| - {status: complete, type: closed, orderindex: 1, color: '#6bc950'} | |
| multiple_assignees: false | |
| features: | |
| due_dates: {enabled: false, start_date: false, remap_due_dates: false, | |
| remap_closed_due_date: false} | |
| time_tracking: {enabled: false} | |
| tags: {enabled: false} | |
| time_estimates: {enabled: false} | |
| checklists: {enabled: true} | |
| custom_fields: {enabled: true} | |
| remap_dependencies: {enabled: false} | |
| dependency_warning: {enabled: false} | |
| portfolios: {enabled: false} | |
| summary: Get Space | |
| operationId: GetSpace | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: space_id, in: path, description: '', required: true, x-example: '790', | |
| type: number} | |
| produces: [application/json] | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Delete Space | |
| operationId: DeleteSpace | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: space_id, in: path, description: '', required: true, x-example: '790', | |
| type: number} | |
| produces: [application/json] | |
| put: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| id: '790' | |
| name: Updated Space Name | |
| private: false | |
| statuses: | |
| - {status: to do, type: open, orderindex: 0, color: '#d3d3d3'} | |
| - {status: complete, type: closed, orderindex: 1, color: '#6bc950'} | |
| multiple_assignees: false | |
| features: | |
| due_dates: {enabled: false, start_date: false, remap_due_dates: false, | |
| remap_closed_due_date: false} | |
| time_tracking: {enabled: false} | |
| tags: {enabled: false} | |
| time_estimates: {enabled: false} | |
| checklists: {enabled: true} | |
| custom_fields: {enabled: true} | |
| remap_dependencies: {enabled: false} | |
| dependency_warning: {enabled: false} | |
| portfolios: {enabled: false} | |
| summary: Update Space | |
| operationId: UpdateSpace | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: space_id, in: path, description: '', required: true, x-example: '790', | |
| type: number} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| multiple_assignees: {type: boolean} | |
| features: | |
| type: object | |
| properties: | |
| due_dates: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| start_date: {type: boolean} | |
| remap_due_dates: {type: boolean} | |
| remap_closed_due_date: {type: boolean} | |
| time_tracking: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| tags: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| time_estimates: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| checklists: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| custom_fields: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| remap_dependencies: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| dependency_warning: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| portfolios: | |
| type: object | |
| properties: | |
| enabled: {type: boolean} | |
| example: | |
| name: Updated Space Name | |
| multiple_assignees: false | |
| features: | |
| due_dates: {enabled: false, start_date: false, remap_due_dates: false, | |
| remap_closed_due_date: false} | |
| time_tracking: {enabled: false} | |
| tags: {enabled: false} | |
| time_estimates: {enabled: false} | |
| checklists: {enabled: true} | |
| custom_fields: {enabled: true} | |
| remap_dependencies: {enabled: false} | |
| dependency_warning: {enabled: false} | |
| portfolios: {enabled: false} | |
| produces: [application/json] | |
| /space/{space_id}/tag: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| tags: | |
| - {name: Tag name, tag_fg: '#000000', tag_bg: '#000000'} | |
| summary: Get Space Tags | |
| operationId: GetSpaceTags | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: space_id, in: path, description: '', required: true, x-example: '512', | |
| type: number} | |
| produces: [application/json] | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Create Space Tag | |
| operationId: CreateSpaceTag | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: space_id, in: path, description: '', required: true, x-example: '512', | |
| type: number} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| tag: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| tag_fg: {type: string} | |
| tag_bg: {type: string} | |
| example: | |
| tag: {name: Tag Name, tag_fg: '#000000', tag_bg: '#000000'} | |
| produces: [application/json] | |
| /space/{space_id}/tag/{tag_name}: | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Delete Space Tag | |
| operationId: DeleteSpaceTag | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: space_id, in: path, description: '', required: true, x-example: '512', | |
| type: number} | |
| - {name: tag_name, in: path, description: '', required: true, x-example: name, | |
| type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| tag: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| tag_fg: {type: string} | |
| tag_bg: {type: string} | |
| example: | |
| tag: {name: Tag name, tag_fg: '#000000', tag_bg: '#000000'} | |
| produces: [application/json] | |
| put: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| tag: {name: Updated Tag, fg_color: '#ffffff', bg_color: '#ffffff'} | |
| summary: Edit Space Tag | |
| operationId: EditSpaceTag | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: space_id, in: path, description: '', required: true, x-example: '512', | |
| type: number} | |
| - {name: tag_name, in: path, description: '', required: true, x-example: name, | |
| type: string} | |
| produces: [application/json] | |
| /task/{task_id}/tag/{tag_name}: | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Remove Tag From Task | |
| operationId: RemoveTagFromTask | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: abc, | |
| type: string} | |
| - {name: tag_name, in: path, description: '', required: true, x-example: name, | |
| type: string} | |
| produces: [application/json] | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Add Tag To Task | |
| operationId: AddTagToTask | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: abc, | |
| type: string} | |
| - {name: tag_name, in: path, description: '', required: true, x-example: name, | |
| type: string} | |
| produces: [application/json] | |
| /task/{task_id}: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| id: 9hx | |
| name: Updated Task Name | |
| status: {status: in progress, color: '#d3d3d3', orderindex: 1, type: custom} | |
| orderindex: '1.00000000000000000000000000000000' | |
| date_created: '1567780450202' | |
| date_updated: '1567780450202' | |
| date_closed: null | |
| creator: {id: 183, username: John Doe, color: '#827718', profilePicture: 'https://attachments-public.clickup.com/profilePictures/183_abc.jpg'} | |
| assignees: [] | |
| checklists: [] | |
| tags: [] | |
| parent: null | |
| priority: null | |
| due_date: null | |
| start_date: null | |
| time_estimate: null | |
| time_spent: null | |
| list: {id: '123'} | |
| folder: {id: '456'} | |
| space: {id: '789'} | |
| url: https://app.clickup.com/t/9hx | |
| summary: Get Task | |
| operationId: GetTask | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hz, | |
| type: string} | |
| produces: [application/json] | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Delete Task | |
| operationId: DeleteTask | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9xh, | |
| type: string} | |
| produces: [application/json] | |
| put: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| id: 9hx | |
| name: Updated Task Name | |
| status: {status: in progress, color: '#d3d3d3', orderindex: 1, type: custom} | |
| orderindex: '1.00000000000000000000000000000000' | |
| date_created: '1567780450202' | |
| date_updated: '1567780450202' | |
| date_closed: null | |
| creator: {id: 183, username: John Doe, color: '#827718', profilePicture: 'https://attachments-public.clickup.com/profilePictures/183_abc.jpg'} | |
| assignees: [] | |
| checklists: [] | |
| tags: [] | |
| parent: null | |
| priority: null | |
| due_date: null | |
| start_date: null | |
| time_estimate: null | |
| time_spent: null | |
| list: {id: '123'} | |
| folder: {id: '456'} | |
| space: {id: '789'} | |
| url: https://app.clickup.com/t/9hx | |
| summary: Update Task | |
| operationId: UpdateTask | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hx, | |
| type: string} | |
| produces: [application/json] | |
| /team/{team_id}/taskTemplate: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| templates: [] | |
| summary: Get Task Templates | |
| operationId: GetTaskTemplates | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: team_id, in: path, description: '', required: true, x-example: '512', | |
| type: number} | |
| - {name: page, in: query, description: '', required: true, x-example: '0', type: integer} | |
| produces: [application/json] | |
| /list/{list_id}/taskTemplate/{template_id}: | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {id: 9hk} | |
| summary: Create Task From Template | |
| operationId: CreateTaskFromTemplate | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: list_id, in: path, description: '', required: true, x-example: '512', | |
| type: number} | |
| - {name: template_id, in: path, description: '', required: true, x-example: 9hz, | |
| type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| name: {type: string} | |
| example: {name: New task name} | |
| produces: [application/json] | |
| /task/{task_id}/time: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| data: | |
| - user: {id: 1, username: John Doe, email: [email protected], color: '#795548', | |
| initials: JD, profilePicture: null} | |
| time: 1000000 | |
| intervals: | |
| - {id: '318', start: null, end: null, time: '1000000', source: chrome, | |
| date_added: '1569983937761'} | |
| summary: Get tracked time | |
| operationId: Gettrackedime | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hv, | |
| type: string} | |
| produces: [application/json] | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: {} | |
| summary: Track time | |
| operationId: Tracktime | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hv, | |
| type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| start: {type: number} | |
| end: {type: number} | |
| time: {type: number} | |
| example: {start: 1567780450202, end: 1508369194377, time: 8640000} | |
| /task/{task_id}/time/{interval_id}: | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Delete time tracked | |
| operationId: Deletetimetracked | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hv, | |
| type: string} | |
| - {name: interval_id, in: path, description: '', required: true, x-example: '123', | |
| type: string} | |
| produces: [application/json] | |
| put: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Edit time tracked | |
| operationId: Edittimetracked | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: task_id, in: path, description: '', required: true, x-example: 9hv, | |
| type: string} | |
| - {name: interval_id, in: path, description: '', required: true, x-example: '123', | |
| type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| start: {type: number} | |
| end: {type: number} | |
| time: {type: number} | |
| example: {start: 1567780450202, end: 1508369194377, time: 8640000} | |
| produces: [application/json] | |
| /view/{view_id}/task: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: {} | |
| summary: Get View Tasks | |
| operationId: GetViewTasks | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: view_id, in: path, description: 105 (string), required: true, x-example: 3c, | |
| type: string} | |
| - {name: page, in: query, description: '', required: true, x-example: '0', type: integer} | |
| /team/{team_id}/webhook: | |
| get: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| webhooks: | |
| - id: 4b67ac88-e506-4a29-9d42-26e504e3435e | |
| userid: 183 | |
| team_id: 108 | |
| endpoint: https://yourdomain.com/webhook | |
| client_id: QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO | |
| events: [taskCreated, taskUpdated, taskDeleted, listCreated, listUpdated, | |
| listDeleted, folderCreated, folderUpdated, folderDeleted, spaceCreated, | |
| spaceUpdated, spaceDeleted, goalCreated, goalUpdated, goalDeleted, | |
| keyResultCreated, keyResultUpdated, keyResultDelted] | |
| task_id: null | |
| list_id: null | |
| folder_id: null | |
| space_id: null | |
| health: {status: failing, fail_count: 5} | |
| secret: O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA | |
| summary: Get Webhooks | |
| operationId: GetWebhooks | |
| description: '**Note** - _Only webhooks that were created by the authenticated | |
| user will be returned on this endpoint.' | |
| tags: [] | |
| parameters: | |
| - {name: team_id, in: path, description: '', required: true, x-example: '512', | |
| type: number} | |
| produces: [application/json] | |
| post: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| id: 4b67ac88-e506-4a29-9d42-26e504e3435e | |
| webhook: | |
| id: 4b67ac88-e506-4a29-9d42-26e504e3435e | |
| userid: 183 | |
| team_id: 108 | |
| endpoint: https://yourdomain.com/webhook | |
| client_id: QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO | |
| events: [taskCreated, taskUpdated, taskDeleted, listCreated, listUpdated, | |
| listDeleted, folderCreated, folderUpdated, folderDeleted, spaceCreated, | |
| spaceUpdated, spaceDeleted, goalCreated, goalUpdated, goalDeleted, | |
| keyResultCreated, keyResultUpdated, keyResultDelted] | |
| task_id: null | |
| list_id: null | |
| folder_id: null | |
| space_id: null | |
| health: {status: active, fail_count: 0} | |
| secret: O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA | |
| summary: Create Webhook | |
| operationId: CreateWebhook | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: team_id, in: path, description: '', required: true, x-example: '512', | |
| type: number} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| endpoint: {type: string} | |
| events: | |
| type: array | |
| items: {type: string} | |
| example: | |
| endpoint: https://yourdomain.com/webhook | |
| events: [taskCreated, taskUpdated, taskDeleted, listCreated, listUpdated, | |
| listDeleted, folderCreated, folderUpdated, folderDeleted, spaceCreated, | |
| spaceUpdated, spaceDeleted, goalCreated, goalUpdated, goalDeleted, keyResultCreated, | |
| keyResultUpdated, keyResultDelted] | |
| produces: [application/json] | |
| /webhook/{webhook_id}: | |
| delete: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: {} | |
| summary: Delete Webhook | |
| operationId: DeleteWebhook | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: webhook_id, in: path, description: e506-4a29-9d42-26e504e3435e (uuid), | |
| required: true, x-example: 4b67ac88, type: string} | |
| produces: [application/json] | |
| put: | |
| responses: | |
| '200': | |
| description: OK | |
| headers: {} | |
| examples: | |
| application/json: | |
| id: 4b67ac88-e506-4a29-9d42-26e504e3435e | |
| webhook: | |
| id: 4b67ac88-e506-4a29-9d42-26e504e3435e | |
| userid: 183 | |
| team_id: 108 | |
| endpoint: https://yourdomain.com/webhook | |
| client_id: QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO | |
| events: [taskCreated, taskUpdated, taskDeleted, listCreated, listUpdated, | |
| listDeleted, folderCreated, folderUpdated, folderDeleted, spaceCreated, | |
| spaceUpdated, spaceDeleted, goalCreated, goalUpdated, goalDeleted, | |
| keyResultCreated, keyResultUpdated, keyResultDelted] | |
| task_id: null | |
| list_id: null | |
| folder_id: null | |
| space_id: null | |
| health: {status: active, fail_count: 0} | |
| secret: O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA | |
| summary: Update Webhook | |
| operationId: UpdateWebhook | |
| description: '' | |
| tags: [] | |
| parameters: | |
| - {name: webhook_id, in: path, description: e506-4a29-9d42-26e504e3435e (uuid), | |
| required: true, x-example: 4b67ac88, type: string} | |
| - name: body | |
| in: body | |
| schema: | |
| type: object | |
| properties: | |
| endpoint: {type: string} | |
| events: {type: string} | |
| status: {type: string} | |
| example: {endpoint: 'https://yourdomain.com/webhook', events: '*', status: active} | |
| produces: [application/json] | |
| definitions: | |
| Attachments: {} | |
| Authorization: {} | |
| Checklists: {} | |
| Comments: {} | |
| Custom Fields: {} | |
| Dependencies: {} | |
| Folders: {} | |
| Goals: {} | |
| Lists: {} | |
| Members: {} | |
| Shared Hierarchy: {} | |
| Spaces: {} | |
| Tags: {} | |
| Tasks: {} | |
| Task Templates: {} | |
| Teams: {} | |
| Time Tracking: {} | |
| Views: {} | |
| Webhooks: {} | |
| securityDefinitions: {} | |
| tags: [] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment