Clickupconnector v1.0 | OneTeg Documentation

Version 1.0

Connector Overview: This page documents all 124 actions for the Clickupconnector v1.0.

Attachments

POST Create Task Attachment

/task/{task_id}/attachment

Upload a file as an attachment to a specific task. Use this to add files to tasks programmatically.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to attach the file to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Attachment`	The file content or URL to attach to the task.

Authorization (3)

POST Get Access Token

/oauth/token

Exchange an OAuth authorization code for an access token. Use this to authenticate API requests after a user authorizes your app.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Client Id`	Your app's OAuth client ID.
`Client Secret`	Your app's OAuth client secret.
`Code`	The authorization code received from the user.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Authorized Teams

/team

Retrieve a list of all teams (workspaces) that the authenticated user belongs to. Use this to discover available workspaces for further operations.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Authorized User

/user

Retrieve information about the currently authenticated user. Use this to verify identity or get user details.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Checklists (6)

POST Create Checklist

/task/{task_id}/checklist

Add a new checklist to a specified task. Use this to break down tasks into sub-items.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to add the checklist to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	The title of the new checklist.

POST Create Checklist Item

/checklist/{checklist_id}/checklist_item

Add a new item to an existing checklist. Use this to populate checklists with actionable items.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Checklist Id`	The ID of the checklist to add the item to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	The text of the checklist item.
`Assignee`	The user ID of the person assigned to this item.

DELETE Delete Checklist

/checklist/{checklist_id}

Permanently remove a checklist and all its items from a task. Use this to clean up unnecessary checklists.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Checklist Id`	The ID of the checklist to delete.
`Content-type`	The content type header for the request (optional).
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete Checklist Item

/checklist/{checklist_id}/checklist_item/{checklist_item_id}

Remove a single item from a checklist. Use this to delete specific checklist items.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Checklist Id`	The ID of the checklist containing the item.
`Checklist Item Id`	The ID of the item to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Edit Checklist

/checklist/{checklist_id}

Update the name or position of an existing checklist. Use this to rename or reorder checklists.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Checklist Id`	The ID of the checklist to edit.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	The new title for the checklist.
`Position`	The new order position for the checklist.

PUT Edit Checklist Item

/checklist/{checklist_id}/checklist_item/{checklist_item_id}

Modify an existing checklist item's properties such as name, assignee, resolved status, or parent item. Use this to update item details.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Checklist Id`	The ID of the checklist containing the item.
`Checklist Item Id`	The ID of the item to edit.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Name`	The new text for the item.
`Assignee`	The user ID or email of the new assignee.
`Resolved`	Whether the item is marked as resolved (true or false).
`Parent`	The ID of the parent checklist item if making this a sub-item.

Comments (8)

POST Create Chat View Comment

/view/{view_id}/comment

Post a comment to a chat view (such as a Chat or Email view). Use this to add messages to discussion threads.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`View Id`	The ID of the chat view to post the comment to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Comment Text`	The text content of the comment.
`Notify All`	Whether to notify all members of the view (true or false).

POST Create List Comment

/list/{list_id}/comment

Add a comment to a list. Use this to communicate about list-level items.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Comment Text`	The text of the comment.
`Assignee`	The user ID to assign the comment to.
`Notify All`	Whether to notify all list members.

POST Create Task Comment

/task/{task_id}/comment

Post a comment on a specific task. Use this to add feedback or notes to a task.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Comment Text`	The text of the comment.
`Assignee`	The user ID to assign the comment to.
`Notify All`	Whether to notify all task watchers.

DELETE Delete Comment

/comment/{comment_id}

Please paste comment_id from original task comment created for continuity

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Comment Id`	The ID of the comment to delete.
`Content-type`	The content type header for the request (optional).
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Chat View Comments

/view/{view_id}/comment

Retrieve all comments posted in a specific chat view. Use this to read discussion history.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`View Id`	The ID of the chat view to get comments from.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get List Comments

/list/{list_id}/comment

Retrieve all comments on a specific list. Use this to view list-level conversations.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to get comments from.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Task Comments

/task/{task_id}/comment

Retrieve all comments associated with a specific task. Use this to view discussion threads or notes attached to a task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update Comment

/comment/{comment_id}

Please paste comment_id from original task comment created for continuity

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Comment Id`	The ID of the comment to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Comment Text`	The text of the comment.
`Assignee`	The user ID to assign the comment to.
`Resolved`	Whether the item is marked as resolved (true or false).

Custom Fields (3)

GET Get Accessible Custom Fields

/list/{list_id}/field

Retrieve the list of custom fields that are accessible for a specific list. Use this to discover available custom fields and their settings before setting or removing values.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to get comments from.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Remove Custom Field Value

/task/{task_id}/field/{field_id}

Remove the value of a custom field from a task. Use this to clear a custom field's data.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Field Id`	The ID of the custom field whose value should be removed from the task.
`Content-type`	The content type header for the request (optional).
`Response Type`	The response format expected from the API (e.g. application/json).

POST Set Custom Field Value

/task/{task_id}/field/{field_id}

Set or update the value of a custom field on a task. Use this to assign a new value to a custom field.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Field Id`	The ID of the custom field to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Value`	The value to assign to the custom field; expected type depends on the field configuration (e.g., integer for number fields).

Dependencies (4)

POST Add Dependency

/task/{task_id}/dependency

Add a dependency relationship where the current task depends on another task. Use this to indicate that the current task cannot start until the specified task is completed.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Depends On`	The ID of the task that the current task depends on.

POST Add Task Link

/task/{task_id}/link/links_to

Create a link between two tasks indicating that the current task links to another task. Use this to establish a generic relationship between tasks.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete Task Link

/task/{task_id}/link/links_to

Remove an existing task link from the current task to another task. Use this to break a generic relationship between tasks.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Remove Dependency

/task/{task_id}/dependency

Remove a dependency relationship from a task. Use this to delete either a "depends on" or "dependency of" link.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Depends On`	The ID of the task that the current task depends on, if removing that type of dependency.
`Dependency Of`	The ID of the task that depends on the current task, if removing that type of dependency.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

Folders (5)

POST Create a Folder

/space/{space_id}/folder

Create a new folder within a specific space. Use this to organize tasks into a new folder.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space where the folder should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	The new text for the item.

DELETE Delete a Folder

/folder/{folder_id}

Please paste previously updated folder_id for continuity

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Folder Id`	The ID of the folder to delete.
`Content-type`	The content type header for the request (optional).
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Folder

/folder/{folder_id}

Retrieve details about a specific folder. Use this to get folder metadata and its contents.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Folder Id`	The ID of the folder to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Folders

/space/{space_id}/folder

Retrieve all folders within a specific space. Use this to list folders for navigation or management.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space whose folders should be listed.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a Folder

/folder/{folder_id}

Please paste previously created folder_id for continuity

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Folder Id`	The ID of the folder to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	The new text for the item.

Goals (8)

POST Create a Goal

/team/{team_id}/goal

Create a new goal within a specific team. Use this to define a measurable objective.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Name`	The new text for the item.
`Due Date`	The due date for the goal as a Unix timestamp in milliseconds.
`Description`	A text description of the goal.
`Multiple Owners`	Whether the goal can have multiple owners (true or false).
`Owners`	An array of user IDs to set as owners of the goal.
`Color`	The color of the goal, specified as a hex color code or predefined color name.

POST Create a Key Result

/goal/{goal_id}/key_result

Please use previously created goal_id created before "Get Goal" for continuity

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Goal Id`	The ID of the goal to which this key result will belong.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Name`	The new text for the item.
`Owners`	An array of user IDs to set as owners of the goal.
`Type`	The type of key result, such as 'number' or 'percentage', defining how progress is measured.
`Steps Start`	The starting value of the key result when using a steps-based type.
`Steps End`	The target value of the key result when using a steps-based type.
`Unit`	The unit label for the key result, like 'tasks' or 'revenue'.
`Task Ids`	An array of task IDs to associate with the key result.
`List Ids`	An array of list IDs to associate with the key result.

DELETE Delete a Goal

/goal/{goal_id}

Please paste goal_id from previously updated Goal for continuity

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Goal Id`	The ID of the goal to delete.
`Content-type`	The content type header for the request (optional).
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a Key Result

/key_result/{key_result_id}

Please post key_result_id from the previously edited key_result for continuity. Please also delete the previously created Goal created for testing the "Get Goal" endpoint.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Key Result Id`	The ID of the key result to delete.
`Content-type`	The content type header for the request (optional).
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Edit a Key Result

/key_result/{key_result_id}

Please paste key_result_id from previously created key_result for continuity

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Key Result Id`	The ID of the key result to edit.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Steps Current`	The current step value of the key result to update its progress.
`Note`	A note or comment to attach to the key result.

GET Get Goal

/goal/{goal_id}

Please paste goal_id after creating another Goal for continuity.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Goal Id`	The ID of the goal to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Goals

/team/{team_id}/goal

Retrieve a list of all goals for a team. Use this to view the team's objectives at a glance.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Content-type`	The content type header for the request (optional).
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a Goal

/goal/{goal_id}

Please paste goal_id from previously created Goal for continuity

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Goal Id`	The ID of the goal to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Name`	The new text for the item.
`Due Date`	The due date for the goal as a Unix timestamp in milliseconds.
`Description`	A text description of the goal.
`Rem Owners`	An array of user IDs to remove as owners of the goal.
`Add Owners`	An array of user IDs to add as owners of the goal.
`Color`	The color of the goal, specified as a hex color code or predefined color name.

Guests (10)

POST Add Guest to Folder

/folder/{folder_id}/guest/{guest_id}

JSON Body:
{
"permission_level": "read" || "comment" || "edit" || "create"
}

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Folder Id`	The ID of the folder to update.
`Guest Id`	The ID of the guest user to add to the folder.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Add Guest to List

/list/{list_id}/guest/{guest_id}

JSON Body:
{
"permission_level": "read" || "comment" || "edit" || "create"
}

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to get comments from.
`Guest Id`	The ID of the guest user to add to the list.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Add Guest to Task

/task/{task_id}/guest/{guest_id}

JSON Body:
{
"permission_level": "read" || "comment" || "edit" || "create"
}

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Guest Id`	The ID of the guest user to add to the task.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Permission Level`	The permission level to assign to the guest for the task, such as 'read' or 'write'.

PUT Edit Guest on Workspace

/team/{team_id}/guest/{guest_id}

Update a guest's permissions on the workspace level. Use this to control what actions the guest can perform.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Guest Id`	The ID of the guest user whose permissions are being edited.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Can Edit Tags`	Whether the guest is allowed to edit tags on tasks.
`Can See Time Spent`	Whether the guest can view time tracked on tasks.
`Can See Time Estimated`	Whether the guest can see estimated time for tasks.
`Can Create Views`	Whether the guest can create custom views.
`Custom Role Id`	The ID of a custom role to assign to the guest for granular permission control.

GET Get Guest

/team/{team_id}/guest/{guest_id}

All the locations on the Workspace the guest has access too

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Guest Id`	The ID of the guest user to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Invite Guest to Workspace

/team/{team_id}/guest

The type of JSON to fill out:
{
"email": "example@gmail.com",
"can_edit_tags": true || false,
"can_see_time_estimated": true || false,
"can_see_time_spent": true || false
}

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Email`	The email address of the guest to invite to the workspace.
`Can Edit Tags`	Whether the guest is allowed to edit tags on tasks.
`Can See Time Estimated`	Whether the guest can see estimated time for tasks.
`Can See Time Spent`	Whether the guest can view time tracked on tasks.
`Can Create Views`	Whether the guest can create custom views.
`Custom Role Id`	The ID of a custom role to assign to the guest for granular permission control.

DELETE Remove Guest from Folder

/folder/{folder_id}/guest/{guest_id}

Remove a guest's access to a specific folder.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Folder Id`	The ID of the folder to update.
`Guest Id`	The ID of the guest user to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Remove Guest from List

/list/{list_id}/guest/{guest_id}

Remove a guest's access to a specific list.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to get comments from.
`Guest Id`	The ID of the guest user to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Remove Guest from Task

/task/{task_id}/guest/{guest_id}

Remove a guest's access to a specific task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Guest Id`	The ID of the guest user to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Remove Guest from Workspace

/team/{team_id}/guest/{guest_id}

Remove a guest from the entire workspace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Guest Id`	The ID of the guest user to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

Lists (9)

POST Add Task To List

/list/{list_id}/task/{task_id}

Add an existing task to a specific list.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to get comments from.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create Folderless List

/space/{space_id}/list

Create a new list that is not inside a folder, within a space.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space whose folders should be listed.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Name`	The new text for the item.
`Content`	The description or content of the list.
`Due Date`	The due date for the goal as a Unix timestamp in milliseconds.
`Due Date Time`	Whether the list's due date includes a specific time. Set to true for date and time, false for date only.
`Priority`	The priority level of the list, using an integer value (e.g., 1 for urgent, 2 for high, 3 for normal, 4 for low).
`Assignee`	The user ID to assign the comment to.
`Status`	The initial status of the list, such as "Open" or "Closed".

POST Create a List

/folder/{folder_id}/list

Create a new list inside a specific folder.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Folder Id`	The ID of the folder to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Name`	The new text for the item.
`Content`	The description or content of the list.
`Due Date`	The due date for the goal as a Unix timestamp in milliseconds.
`Due Date Time`	Whether the list's due date includes a specific time. Set to true for date and time, false for date only.
`Priority`	The priority level of the list, using an integer value (e.g., 1 for urgent, 2 for high, 3 for normal, 4 for low).
`Assignee`	The user ID to assign the comment to.
`Status`	The initial status of the list, such as "Open" or "Closed".

DELETE Delete a List

/list/{list_id}

Please paste previously updated list_id for continuity

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to get comments from.
`Content-type`	The content type header for the request (optional).
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Folderless Lists

/space/{space_id}/list

Retrieve all lists that are not inside a folder for a given space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space whose folders should be listed.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get List

/list/{list_id}

Retrieve details of a specific list by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to get comments from.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Lists

/folder/{folder_id}/list

Retrieve all lists within a specific folder.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Folder Id`	The ID of the folder to update.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Remove Task From List

/list/{list_id}/task/{task_id}

Remove a task from a specific list.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to get comments from.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a List

/list/{list_id}

Please paste previously created list_id for continuity

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to get comments from.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Name`	The new text for the item.
`Content`	The description or content of the list.
`Due Date`	The due date for the goal as a Unix timestamp in milliseconds.
`Due Date Time`	Whether the list's due date includes a specific time. Set to true for date and time, false for date only.
`Priority`	The priority level of the list, using an integer value (e.g., 1 for urgent, 2 for high, 3 for normal, 4 for low).
`Assignee`	The user ID or email of the new assignee.

Members (2)

GET Get List Members

/list/{list_id}/member

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to get comments from.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Task members

/task/{task_id}/member

Retrieve the members assigned to a specific task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

Roles

GET Get Custom Roles

/{team_id}/customRoles

List all custom roles defined for a team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Shared Hierarchy

GET Get Shared Hierarchy

/team/{team_id}/shared

Retrieve the shared hierarchy structure for a team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Spaces (5)

POST Create a Space

/team/{team_id}/space

Create a new space within a team.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	The new text for the item.
`Multiple Assignees`	Enable or disable multiple assignees for tasks in the space.

DELETE Delete a Space

/space/{space_id}

Please paste the previously updated space_id for continuity

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space whose folders should be listed.
`Content-type`	The content type header for the request (optional).
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Space

/space/{space_id}

Retrieve details of a specific space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space whose folders should be listed.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Spaces

/team/{team_id}/space

List all spaces within a team, with an optional filter for archived spaces.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Archived`	Filter spaces by archived status; pass "true" to show only archived spaces.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a Space

/space/{space_id}

Please paste the previously created space_id for continuity

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space whose folders should be listed.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Name`	The new text for the item.
`Color`	The color of the goal, specified as a hex color code or predefined color name.
`Private`	Set the space to private or public.
`Admin Can Manage`	Allow only admins to manage the space.
`Multiple Assignees`	Enable or disable multiple assignees for tasks in the space.

Tags (6)

POST Add Tag To Task

/task/{task_id}/tag/tag_name

Add a tag to a task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Custom Task Ids`	Specify custom task IDs if used; otherwise leave blank.
`Team Id`	The team ID required when using custom task IDs.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create a Space Tag

/space/{space_id}/tag

Create a new tag within a space.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space whose folders should be listed.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete a Space Tag

/space/{space_id}/tag/tag_name

Permanently delete a specific tag from a space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space whose folders should be listed.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Edit a Space Tag

/space/{space_id}/tag/tag_name

Update the name or color of an existing space tag.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space whose folders should be listed.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Space Tags

/space/{space_id}/tag

Retrieve all tags defined in a space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space whose folders should be listed.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Remove Tag From Task

/task/{task_id}/tag/tag_name

Remove a tag from a task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Custom Task Ids`	Specify custom task IDs if used; otherwise leave blank.
`Team Id`	The team ID required when using custom task IDs.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

Task Templates (2)

POST Create Task From Template

/list/{list_id}/taskTemplate/{template_id}

Create a new task from a specified template in a list.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to get comments from.
`Template Id`	The unique identifier of the template to use for creating the task.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	The new text for the item.

GET Get Task Templates

/team/{team_id}/taskTemplate

Retrieve all task templates available for a team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Page`	The page number of results to return.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Tasks (8)

POST Create a Task

/list/{list_id}/task

Add a new task to a specified list.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to get comments from.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (14)

Option Name	Description
`Name`	The new text for the item.
`Description`	A text description of the goal.
`Assignees`	An array of user IDs to assign to the task.
`Tags`	An array of tag names to add to the task.
`Status`	The initial status of the list, such as "Open" or "Closed".
`Priority`	The priority level of the list, using an integer value (e.g., 1 for urgent, 2 for high, 3 for normal, 4 for low).
`Due Date`	The due date for the goal as a Unix timestamp in milliseconds.
`Due Date Time`	Whether the list's due date includes a specific time. Set to true for date and time, false for date only.
`Time Estimate`	The estimated time in milliseconds for the task.
`Start Date`	The start date of the task as a Unix timestamp in milliseconds.
`Start Date Time`	Whether the start date includes a specific time.
`Notify All`	Whether to notify all task watchers.
`Parent`	The ID of the parent checklist item if making this a sub-item.
`Links To`	The ID of a task to link this task to.

DELETE Delete a Task

/task/{task_id}

Please delete previously created/updated task for continuity

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Custom Task Ids`	Specify custom task IDs if used; otherwise leave blank.
`Team Id`	The team ID required when using custom task IDs.
`Task Id`	The ID of the task to comment on.
`Content-type`	The content type header for the request (optional).
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Bulk Tasks' Time in Status

/task/bulk_time_in_status/task_ids

Retrieve the time spent in each status for multiple tasks specified by their IDs.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Custom Task Ids`	Specify custom task IDs if used; otherwise leave blank.
`Team Id`	The team ID required when using custom task IDs.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Filtered Team Tasks

/team/{team_id}/task

Retrieve a filtered list of tasks for a team based on query parameters.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Task

/task/{task_id}

Retrieve detailed information about a specific task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Task's Time in Status

/task/{task_id}/time_in_status

Retrieve the time spent in each status for a specific task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Custom Task Ids`	Specify custom task IDs if used; otherwise leave blank.
`Team Id`	The team ID required when using custom task IDs.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Tasks

/list/{list_id}/task

Retrieve a list of tasks from a specific list, with optional filters for pagination, ordering, status, assignees, dates, and custom fields.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Page`	Specifies the page number for paginated results.
`Order By`	Defines the field by which tasks are sorted, such as 'created' or 'updated'.
`Reverse`	When set to 'true', reverses the sort order of the results.
`Subtasks`	When set to 'true', includes subtasks in the results.
`Space Ids[]`	Filters tasks by one or more space IDs.
`Project Ids[]`	Filters tasks by one or more project IDs.
`Statuses[]`	Filters tasks by one or more status values.
`Include Closed`	When set to 'true', includes closed or completed tasks.
`Assignees[]`	Filters tasks by one or more assignee user IDs.
`Due Date Gt`	Returns tasks with a due date greater than the specified timestamp.
`Due Date Lt`	Returns tasks with a due date less than the specified timestamp.
`Date Created Gt`	Returns tasks created after the specified timestamp.
`Date Created Lt`	Returns tasks created before the specified timestamp.
`Date Updated Gt`	Returns tasks updated after the specified timestamp.
`Date Updated Lt`	Returns tasks updated before the specified timestamp.
`Custom Fields`	Filters tasks by custom field values, provided as a JSON string.
`Custom Task Ids`	Specify custom task IDs if used; otherwise leave blank.
`Team Id`	The team ID required when using custom task IDs.
`List Id`	The ID of the list to get comments from.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a Task

/task/{task_id}

Paste task_id from previously created task.

Make sure to update all fields when testing to make sure they are all updated.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Custom Task Ids`	Specify custom task IDs if used; otherwise leave blank.
`Team Id`	The team ID required when using custom task IDs.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Name`	The new text for the item.
`Description`	A text description of the goal.
`Status`	The initial status of the list, such as "Open" or "Closed".
`Priority`	The priority level of the list, using an integer value (e.g., 1 for urgent, 2 for high, 3 for normal, 4 for low).
`Time Estimate`	The estimated time in milliseconds for the task.
`Archived`	Set to 'true' to archive the task, or 'false' to unarchive it.

Teams (User Groups) (4)

POST Create a Team

/team/{team_id}/group

Create a new team group within a specified workspace.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	A JSON object containing the group name and other configuration settings.

DELETE Delete a Team

/group/{group_id}

Permanently delete a team group.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Group Id`	The unique identifier of the team group to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Teams

/team/{team_id}/group

Retrieve all team groups within a specified workspace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update Team

/group/{group_id}

Update the name or settings of an existing team group.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Group Id`	The unique identifier of the team group to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	A JSON object with the new group properties, such as name or permissions.

Teams (Workspaces)

GET Get Workspace Seats

/team/{workspace_id}/seats

Retrieve the seat count and usage details for a workspace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Workspace Id`	The unique identifier of the workspace.
`Response Type`	The response format expected from the API (e.g. application/json).

Time Tracking 2.0 (13)

POST Add tags from time entries

/team/{team_id}/time_entries/tags

Add tags to specific time entries.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Time Entry Ids`	An array of time entry identifiers to which the tags will be added.

PUT Change tag names from time entries

/team/{team_id}/time_entries/tags

Rename tags and update their colors across time entries.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Name`	The new text for the item.
`New Name`	The new name for the tag.
`Tag Bg`	The background color of the tag as a hex code.
`Tag Fg`	The foreground color of the tag as a hex code.

POST Create a time entry

/team/{team_id}/time_entries

Create a new time entry in the specified team's time tracking system.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Description`	A text description of the goal.
`Start`	The Unix timestamp in milliseconds representing when the time entry started.
`Created With`	A string identifying the application or tool that created the time entry.
`Billable`	A boolean indicating whether the time entry should be marked as billable.
`Duration`	The duration of the time entry in milliseconds.
`Assignee`	The user ID to assign the comment to.

DELETE Delete time a time entry

/team/{team_id}/time_entries/{time_entry_id}

Permanently delete a specific time entry by its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Time Entry Id`	The unique identifier of the time entry to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get all tags from time entries

/team/{team_id}/time_entries/tags

Retrieve a list of all tags used across time entries in the specified team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get running time entry

/team/{team_id}/time_entries/current

Return the currently running time entry for the authenticated user in the specified team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get singular time entry

/team/{team_id}/time_entries/{time_entry_id}

Retrieve the details of a single time entry by its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Time Entry Id`	The unique identifier of the time entry to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get time entries within a date range

/team/{team_id}/time_entries

Retrieve time entries for the specified team, typically filtered by a date range using query parameters.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get time entry history

/team/{team_Id}/time_entries/{timer_id}/history

Get the edit history of a specific time entry or timer.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The unique identifier of the team that owns the time entry.
`Timer Id`	The unique identifier of the timer or time entry whose history is being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Remove tags from timer entry

/team/{team_id}/time_entries/tags

Remove all tags from the current time entry or from specified time entries using query parameters.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Content-type`	The content type header for the request (optional).
`Response Type`	The response format expected from the API (e.g. application/json).

POST Start a time entry

/team/{team_id}/time_entries/start/{timer_id}

Start a timer for a specific time entry, beginning its duration tracking.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Timer Id`	The unique identifier of the time entry to start.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Stop current time entry

/team/{team_id}/time_entries/stop

Stop the currently running time entry for the authenticated user in the specified team.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update a time entry

/team/{team_id}/time_entries/{timer_id}

Update the details of an existing time entry, such as its start time, end time, duration, billable status, or tags.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Custom Task Ids`	Specify custom task IDs if used; otherwise leave blank.
`Team Id`	The ID of the team where the goal should be created.
`Timer Id`	The unique identifier of the time entry to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Description`	A text description of the goal.
`Tags`	An array of tag names to add to the task.
`Tag Action`	A string specifying whether to add or remove tags from the time entry.
`Start`	The Unix timestamp in milliseconds for the new start time of the time entry.
`End`	The Unix timestamp in milliseconds for the new end time of the time entry.
`Tid`	A string representing the task ID to associate with the time entry.
`Billable`	A boolean indicating whether the time entry should be marked as billable.
`Duration`	The duration of the time entry in milliseconds.
`Assignee`	The user ID to assign the comment to.

Time Tracking Legacy (4)

DELETE Delete Time Tracked

/task/{task_id}/time/{interval_id}

Delete a legacy time tracking interval from a specific task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Interval Id`	The unique identifier of the time interval to delete.
`Content-type`	The content type header for the request (optional).
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Edit Time Tracked

/task/{task_id}/time/{interval_id}

Update the start time, end time, or total time of a legacy time tracking interval.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Interval Id`	The unique identifier of the time interval to edit.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Start`	The Unix timestamp in milliseconds for the new start time of the interval.
`End`	The Unix timestamp in milliseconds for the new end time of the interval.
`Time`	The total duration of the interval in milliseconds.

GET Get Time Tracked

/task/{task_id}/time

Retrieve the total time tracked for a specific task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Track Time

/task/{task_id}/time

Add time entries to a task, recording the duration and description of tracked time.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Task Id`	The ID of the task to comment on.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Start`	The Unix timestamp in milliseconds for the new start time of the interval.
`End`	The Unix timestamp in milliseconds for the new end time of the interval.
`Time`	The total duration of the interval in milliseconds.

Users (4)

PUT Edit User on Workspace

/team/{team_id}/user/{user_id}

Update a user's properties on a workspace, such as their username or admin status.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`User Id`	The unique identifier of the user to edit on the workspace.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Username`	The new username to assign to the user.
`Admin`	Whether to grant or revoke admin privileges for the user on the workspace.
`Custom Role Id`	The ID of a custom role to assign to the guest for granular permission control.

GET Get User

/team/team_id/user/{user_id}

Retrieve details of a specific user within a workspace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`User Id`	The unique identifier of the user whose information is being retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Invite User to Workspace

/team/{team_id}/user

Send an invitation to a new user to join the workspace.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Email`	The email address of the guest to invite to the workspace.
`Admin`	Whether the invited user should be granted admin privileges on the workspace.
`Custom Role Id`	The ID of a custom role to assign to the guest for granular permission control.

DELETE Remove User From Workspace

/team/team_id/user/{user_id}

Permanently remove a user from the workspace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`User Id`	The unique identifier of the user to remove from the workspace.
`Response Type`	The response format expected from the API (e.g. application/json).

Views (12)

POST Create Folder View

/folder/{folder_id}/view

Create a new custom view within a folder to display tasks with specific filters and groupings.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Folder Id`	The ID of the folder to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	The new text for the item.
`Type`	The type of key result, such as 'number' or 'percentage', defining how progress is measured.

POST Create List View

/list/{list_id}/view

Create a new custom view within a list to display tasks with specific filters and groupings.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to get comments from.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	The new text for the item.
`Type`	The type of key result, such as 'number' or 'percentage', defining how progress is measured.

POST Create Space View

/space/{space_id}/view

Create a new custom view within a space to display tasks with specific filters and groupings.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space whose folders should be listed.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	The new text for the item.
`Type`	The type of key result, such as 'number' or 'percentage', defining how progress is measured.

POST Create Team View

/team/{team_id}/view

Create a new custom view at the team level to display tasks across the entire workspace with specific filters and groupings.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	The new text for the item.
`Type`	The type of key result, such as 'number' or 'percentage', defining how progress is measured.

DELETE Delete a View

/view/{view_id}

Please paste view_id from a view on "Everything" for continuity

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`View Id`	The ID of the chat view to get comments from.
`Content-type`	The content type header for the request (optional).
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Folder Views

/folder/{folder_id}/view

Retrieve all custom views associated with a specific folder.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Folder Id`	The ID of the folder to update.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get List Views

/list/{list_id}/view

Retrieve all custom views associated with a specific list.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`List Id`	The ID of the list to get comments from.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Space Views

/space/{space_id}/view

Retrieve all custom views associated with a specific space.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Space Id`	The ID of the space whose folders should be listed.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Team Views

/team/{team_id}/view

Retrieve all custom views associated with the entire team or workspace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get View

/view/{view_id}

Please paste view_id from "API V2 View" on "API V2 Test Space" for continuity

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`View Id`	The ID of the chat view to get comments from.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get View Tasks

/view/{view_id}/task

Retrieve the list of tasks that are visible within a specific custom view, respecting the view's filters and groupings.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Page`	The page number of results to return.
`View Id`	The ID of the chat view to get comments from.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update View

/view/{view_id}

Please paste view_id from "API V2 View" on "API V2 Test Space" for continuity

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`View Id`	The ID of the chat view to get comments from.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	The new text for the item.
`Type`	The type of key result, such as 'number' or 'percentage', defining how progress is measured.

Webhooks (4)

POST Create a Webhook

/team/{team_id}/webhook

Create a new webhook to subscribe to specific events and receive notifications at a given endpoint.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Endpoint`	The URL that will receive the webhook event payloads.
`Events`	The list of event types to subscribe to, such as task creation or status changes.

DELETE Delete a Webhook

/webhook/{webhook_id}

Please paste webhook_id from previously created webhook for continuity

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Webhook Id`	The unique identifier of the webhook to delete.
`Content-type`	The content type header for the request (optional).
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Webhooks

/team/{team_id}/webhook

Please create another webhook and test afterward

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Team Id`	The ID of the team where the goal should be created.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update Webhook

/webhook/{webhook_id}

Update the endpoint or subscribed events of an existing webhook.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Webhook Id`	The unique identifier of the webhook to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Endpoint`	The new URL that will receive the webhook event payloads.
`Events`	The updated list of event types to subscribe to.
`Status`	The initial status of the list, such as "Open" or "Closed".