Schemas

AppResponse

id

string · required

Application ID

name

string · required

Name

logo

string · required

Logo

redirect_urls

string · required

Redirect URLs

description

string · required

Description

scopes

string · enum · required

Application scope

Enum values:

file

label

doc

milestone

message

subtask

project

task_group

created_by

string · required

Created by

created_at

string · date-time · required

Created date

updated_at

string · date-time · required

Last updated date

GenerateRefreshToken

code

string · required

Code will be come from the authorize url call back redirect url.

Example: Pk6DnFY4q9Z1X7aOQATV5z4bxg1rjwH4

refresh_token

string · required

Refresh Token

grant_type

string · enum · required

grant_type

Enum values:

authorization_code

refresh_token

redirect_uri

string · required

Redirect URI

TokenResponse

access_token

string · required

Access Token

token_type

string · required

Token Type

refresh_token

string · required

Refresh token

expires_in

number · required

Expires in seconds

scope

string · enum · required

Scope

Enum values:

file

label

doc

milestone

message

subtask

project

task_group

ChatMemberResponse

id

string · required

is_owner

boolean · required

is_muted

boolean · required

joined

boolean · required

ChatResponse

id

string · required

name

string · required

type

string · required

description

string · required

team

string · required

project

string · required

is_self

boolean · required

ChatMemberResponse · required

created_at

string · date-time · required

last_message_at

string · date-time · required

zoom_id

string · required

zoom_password

string · required

zoom_join_url

string · required

webex_id

string · required

webex_password

string · required

webex_join_url

string · required

pinned_message

string · required

pinned_by

string · required

meeting_type

string · required

CreateDocument

name

string

Name

parent_doc_id

string

Parent Document ID

project_id

string

Project ID

googleAccessToken

string

Google Access Token

type

string

Type of Document

subtype

string

Subtype of the document

private

boolean

Private Flag

access_type

number · enum

Enum values:

content

object

Document Content

external_id

string

External ID

folder_id

string

Folder ID

folder_stack

string[]

Folder stack

order

number

Document Order

CreateDocumentResponse

message

string · required

Operation message

doc_id

string · required

Document ID

folder

string · required

folde

DocumentMemberResponse

id

string · required

permission

string · required

is_author

boolean · required

active

boolean · required

last_seen

string · date-time · required

last_edited

string · date-time · required

DocumentResponse

id

string · required

name

string · required

access_type

string · required

type

string · required

subtype

string · required

external_id

string · required

content

object · required

author

string · required

project_id

string · required

tasks

string[] · required

archived

boolean · required

DocumentMemberResponse[] · required

discussion_keys

string[] · required

public_token

string · required

share_token

string · required

created_at

string · date-time · required

comments

number · required

hasAccess

boolean · required

labels

string[] · required

folder

string · required

order

number · required

multipage

boolean · required

parent_doc_id

string · required

GetDocumentsResponse

DocumentResponse[] · required

hasMore

boolean · required

True if there are more record else false

Default: false

CreatePersonalDocumentResponse

message

string · required

Message

doc_id

string · required

Document ID

EditDocument

name

string

Document name

archived

boolean

Archived

access_type

number · enum

Enum values:

force

boolean

Force Flag

content

object

folder_id

string

Folder ID

folder_stack

string[]

Folder path stack

multipage

boolean

Is Multiple page?

order

number

Document Order

MoveDocument

folder_id

string · required

Folder ID

folder_stack

string · required

Folder stack of document path

project_id

string · required

Project ID associated with the document

RemoveDocumentResponse

message

string · required

DocumentInvitee

id

string · required

permission

number · enum · required

Permission

Enum values:

DocumentInvite

DocumentInvitee[] · required

Document Invitee details

folder_stack

string[]

Folder stack

AddMembersToDocumentResponse

message

string · required

added_members

string[] · required

updated_members

string[] · required

DocumentMemberRemove

members

string[] · required

Document members

RemoveMembersFromDocumentResponse

message

string · required

members_id

string[] · required

ProcessDocumentChangeResponse

success

boolean · required

UpdateLabels

labels

string[] · required

Labels

AddLabelsReponse

message

string · required

Message

labels

string[] · required

List of labels

RemoveLabelsResponse

message

string · required

Message

labels

string[] · required

List of labels

CustomFieldOptionResponse

id

string · required

value

string · required

Value

color

string · required

Color

CustomFieldResponse

id

string · required

name

string · required

Name

description

string · required

Description

type

string · required

Type

currency

string · required

Currency

tracking_type

string · required

Tracking Type

cost_per_hour

number · required

Cost Per Hour

associations

string[] · required

List of associations

hidden

string[] · required

List of hidden

CustomFieldOptionResponse[] · required

projects

string[] · required

List of Projects

in_library

boolean · required

FileFullResponse

id

string · required

name

string · required

size

number · required

url

string · required

download

string · required

thumbnail

string · required

uploader

string · required

comments

number · required

Number of comments

created_at

string · date-time · required

googleId

string · required

googleType

string · required

processed

boolean · required

task

string · required

Task

project_id

string · required

Project ID

message

string · required

Message

labels

string[] · required

List of labels

folder

string · required

folder

folder_stack

string[] · required

Folder path stack

document

string · required

Document

annotations_task_id

string · required

Annotation Task ID

GetFilesResponseDto

FileFullResponse[] · required

List of Label records

hasMore

boolean

True if there are more record else false

Default: false

FilesUploadDto

files

string[] · application/octet-stream

It contains list of files path from local desktop to upload.

UploadFilesResponseDto

FileFullResponse[] · required

List of Label records

message

string

Success message

GeneralFileResponse

message

string · required

Success message

id

string · required

Created Label ID

CopyFile

task_id

string · required

Task ID associated with the file

message_id

string · required

Message ID associated with the file

project_id

string · required

Project ID associated with the file

UpdateFile

folder_id

string

Folder ID

folder_stack

string[]

Folder stack

annotations_task_id

string

Annotations Task ID

UpdateFileResponse

message

string · required

Message

file_id

string · required

File ID

CreateFolderDTO

project_id

string · required

Project ID

folder_name

string · required

Folder name

type

string · required

Type

parent_folder

string · required

Parent Folder Id

folder_stack

string[] · required

Folder stack

FolderResponse

UpdateFolderDTO

name

string · required

Folder name

parent_folder

string · required

Parent Folder Id

folder_stack

string[] · required

Folder stack

UpdateFolderResponse

success

boolean · required

Success

folder

object · required

Folder Id

InviteeUser

id

string · required

User ID

name

string · required

Name

email

string · required

Email address

signedUp

string · required

Signedup Flag

signupDate

string · date-time · required

Signedup date

InviteeRole

id

string · required

Role ID

name

string · required

Role Name

InviteTeamMember

id

string · required

Team Member Id

object · required

User details

object · required

Role details

InviteTeamReponse

id

string · required

Team ID

name

string · required

Team name

url

string · required

Team URL

InviteTeamMember[] · required

Team member

LabelResponse

id

string · required

name

string · required

color

string · required

type

string · required

created_by

string · required

team

string · required

default

string · required

GetLabelsDto

LabelResponse[] · required

List of Label records

hasMore

boolean

True if there are more record else false

Default: false

LabelBody

name

string · required

Name

color

string · required

Color

type

number · enum

Type

Enum values:

GeneralLabelResponse

message

string · required

Success message

id

string · required

Label Record Unique ID

UpdateLabelBody

name

string · required

Name

color

string · required

Color

StoryPointsStatistic

total

number · required

completed

number · required

ExtendedMemberView

object · required

Story Points details

GetMembersReponse

ExtendedMemberView[] · required

List of members

has_more

boolean · required

Has more row flag

Task

CreateMessageDto

type

string · required

Message Type

text

string · required

Message Text

url

string · required

URL

doc_attachment

string · required

Document Attachment

entity_key

string · required

Entity Key

chat_id

string · required

Chat ID

message_id

string · required

Message ID

task_id

string · required

Task ID

file_id

string · required

File ID

doc_id

string · required

Document ID

task

object

Task Details

external_files

string[]

List of External files

nifty_files

string[]

List of Nifty Files

date

string · date-time

Date

bot_name

string

BOT Name

bot_avatar

string

BOT Avtar

hidden

string[]

Hidden

emails

string

Emails

annotation_id

string

Annotation ID

context_text

string

Context Text

audio_duration

string

Audion Duration

CreateMessageResponse

message

string · required

data

object · required

FileChildResponse

id

string · required

name

string · required

size

number · required

url

string · required

download

string · required

thumbnail

string · required

uploader

string · required

comments

number · required

created_at

string · date-time · required

googleId

string · required

googleType

string · required

processed

boolean · required

MessageResponse

id

string · required

Message Id

type

string · required

Message Type

hide_link_preview

boolean · required

Hide Link Preview

subtype

string · required

Sub Type

text

string · required

Message text

url

string · required

URL

chat

string · required

Chat Id

thread

string · required

Thread

task

string · required

Task Id

file

string · required

File

document

string · required

Document Id

entity_key

string · required

Entity Key

author

string · required

Author Id

replies

number · required

No of Replies

repliers

string[] · required

List of Replier Id

tagged

string[] · required

List of tagged

seen_by

string[] · required

List of Seen by Id

hidden

string[] · required

Hidden

doc_attachment

string · required

Document Attachment

FileChildResponse[] · required

is_edited

boolean · required

Is Edited

is_deleted

boolean · required

Is Deleted

created_at

string · date-time · required

Created At

updated_at

string · date-time · required

Updated At

annotation_id

string · required

Annottion Id

heardBy

string[] · required

Heard By

audio_duration

number · required

Audio duration

heard

boolean · required

Is Heard

GetMessagesResponse

MessageResponse[] · required

List of messages

has_more

boolean · required

Has more row flag

EditMessageDto

text

string

Message Text

object[]

List of External Files

hide_link_preview

boolean

Hide link preview

nifty_files

string[]

List of Nifty Files

DeleteMessageResponse

message_id

string · required

Message ID

message

string · required

Message

SeeMessageResponse

message_ids

string[] · required

List of all message id

message

string · required

Message

HearMessageResponse

message_id

string · required

Message ID

message

string · required

Message

AttachedCustomFieldResponse

id

string · required

value

string · required

Value

TasksStatistic

total

number · required

Total

completed

number · required

Completed

overdue

number · required

Overdue

total_story_points

number · required

Total Story Point

completed_story_points

number · required

Completed Story Point

MilestoneShortView

id

string · required

Milestone ID

name

string · required

Milestone Name

created_at

string · date-time · required

Creation Date

created_by

string · required

Operation message

description

string · required

Description

dependency

string · required

Dependencies

start

string · date-time · required

Start Date

end

string · date-time · required

End Date

archived

string · required

achived

project

string · required

Project

task_group

string · required

Task Group

rule

string · required

Rules

tasks

string[] · required

List of Tasks

hidden

string[] · required

hidden

AttachedCustomFieldResponse[] · required

TasksStatistic · required

order

number · required

Order

color

string · required

Color

is_list

boolean · required

List Flag

assignees

string[] · required

Assignee to List

GetMilestonesReponse

hasMore

boolean · required

True if there are more record else false

Default: false

MilestoneShortView[] · required

List of Label records

CreateMilestone

project_id

string · required

Project ID

name

string · required

Milestone name

description

string · required

Milestone Description

task_group_id

string

Task Group ID

dependency

string

Milestone dependency

start

string

Milestone start date

end

string

Milestone end date

rule_id

string

Milestone rule id

hidden

string[]

Hidden

isTaskGroup

boolean

Is Task Group?

is_list

boolean

List Flag

MilestoneReponse

message

string · required

Success message

id

string · required

Created Label ID

UpdateMilestoneDto

name

string

Milestone name

description

string

Milestone description

dependency

string

Milestone dependencies

start

string

Milestone start date

end

string

Milestone end date

rollup

string

Milestone rollup

is_list

boolean

List Flag

UpdateMilestoneResponse

message

string · required

Success message

MoveToProjectMilestoneDto

project_id

string · required

Project ID

UpdateTasks

tasks

string[] · required

List of Tasks ID

MilestoneTasksResponse

message

string · required

Success message

tasks

string[] · required

List of tasks

UpdateStatus

archived

boolean · required

Archived

tasks

boolean

Task Flag

ProjectResponse

id

string · required

nice_id

string · required

name

string · required

description

string · required

initials

string · required

logo

string · required

color

string · required

secondary_color

string · required

demo

boolean · required

archived

boolean · required

auto_milestones

boolean · required

default_tasks_view

string · required

access_type

string · required

owner

string · required

members

string[] · required

general_discussion

string · required

subteam

string · required

progress

number · required

joined

boolean · required

general_discussion_muted

boolean · required

email

string · required

zoom_id

string · required

zoom_password

string · required

zoom_join_url

string · required

webex_id

string · required

webex_password

string · required

webex_join_url

string · required

enabled_modules

string[] · required

disabled_modules

string[] · required

disabled_widgets

number · enum · required

Enum values:

hidden_taskboard_fields

number · enum · required

Enum values:

repo

string · required

total_story_points

number · required

completed_story_points

number · required

pinned_message

string · required

pinned_by

string · required

completion_groups

string[] · required

doc_root_folder

object · required

file_root_folder

object · required

removed

boolean · required

rollups

string[] · required

list_columns_order

string[] · required

hidden_list_columns

string[] · required

integrations

string[] · required

Integration details

GetProjectsReponses

ProjectResponse[] · required

List of Projects

hasMore

boolean · required

True if there are more record else false

Default: false

CreateProjectDto

name

string · required

Name

subteam_id

string

Subteam ID

description

string

Description

demo

boolean

Demo

template_id

string

Template ID

nice_id

string

Nice ID

access_type

string

Access Type

project_type

string

Project Type

default_tasks_view

string

Default Task View

disabled

string[]

Disabled

UploadedFileS3

GeneralProjectReponse

message

string · required

Success message

id

string · required

Created ID

DeleteProjectReponse

message

string · required

Success message

InviteProjectMember

email

string · required

role

string · required

Role type any of the owner, manager, regular, client

name

string

Name

InviteProjectDto

InviteProjectMember[] · required

Invitees

ProjectInviteResponse

message

string · required

Operation message

object[] · required

Invited

LeaveProjectReponse

message

string · required

Success message

member_id

string · required

Member ID

CustomFieldOptions

value

string · required

Custom field option value

color

string · required

Custom field option color

CreateCustomField

name

string · required

Custom field name

type

number · enum · required

Custom field type

Enum values:

CustomFieldOptions[] · required

roles

string[] · required

Roles

field_id

string

field_id

description

string

description

currency

string

Currency

tracking_type

number · enum

Tracking Type

Enum values:

cost_per_hour

number

Cost per hour

save

boolean

Save

association

string

Association

project_id

string

Project ID

CreateSubteam

SubteamGeneralResponse

message

string · required

id

string · required

SubteamResponse

id

string · required

name

string · required

initials

string · required

logo

string · required

color

string · required

secondary_color

string · required

is_general

boolean · required

owner

string · required

members

string[] · required

GetSubTeamsResponse

SubteamResponse[] · required

items

boolean · required

True if there are more record else false

Default: false

hasMore

boolean · required

True if there are more record else false

Default: false

UpdateSubteam

SubteamMembersModify

members_ids

string[] · required

List of Members ID

RelatedPR

number

string · required

title

string · required

url

string · required

status

string · required

TaskResponse

GetTasksResponse

TaskResponse[] · required

List of all tasks

hasMore

boolean · required

True if there are more record else false

Default: false

CreateTaskFieldBody

id

string · required

value

string · required

Value

CreateTaskBody

name

string · required

Name

task_group_id

string · required

Task Group ID

description

string

Description

order

number

Order

task_id

string

Task Id. This field is mandatory only when we want to create this task as subtask of other task.

milestone_id

string

Milestone ID

rule_id

string

Rule ID

annotation_id

string

Annotation ID

due_date

string

Due Date

start_date

string

Start Date

assignees

string[]

List of Assignees

labels

string[]

List of labels

meeting_ids

string[]

List of meeting ID

embed_url

string

Embed URL

banner

string

Banner

CreateTaskFieldBody[]

Task Field Body

story_points

number

Story Points

dependency

object

Dependency Task

GetPersonalTasksDto

limit

string · required

No of records per page

Example: 25

offset

string

Record Offset

Example: 0

meeting_id

string

Meeting ID

completed

boolean

Completed?

UpdateTaskResponse

message

string · required

Success message

RemoveTaskResponse

message

string · required

Success message

UpdateTaskMilestoneReponse

message

string · required

Success message

CompletedTaskResponse

message

string · required

Success message

MoveTarget

type

string · required

Type

id

string · required

MoveTaskNew

object · required

task_order

string

Task Order

next_task

string

Next Task

prev_task

string

Previous Task

AssigneesBody

assignees

string[] · required

List of Assignees

AddLabelsToTaskResponse

message

string · required

labels

string[] · required

RemoveTasks

project_id

string

Project ID

task_ids

string[]

List of Task ID

MoveTasks

object · required

task_ids

string[] · required

List of Task ID

TaskGroupResponse

id

string · required

name

string · required

order

number · required

project_id

string · required

color

string · required

milestone

string · required

is_completion_group

boolean · required

assignees

string[] · required

hidden

string[] · required

rollup

object · required

GetTaskGroupsResponse

TaskGroupResponse[] · required

hasMore

boolean

True if there are more record else false

Default: false

CreateTaskGroupBody

name

string · required

Name

project_id

string · required

Project ID

order

number

Order

color

string

Color

isCompletionGroup

boolean

Is Completion Group

TaskGroupCompactResponse

id

string · required

name

string · required

created_by

string · required

project

string · required

color

string · required

order

number · required

assignees

string[] · required

rollup

string · required

UpdateTaskGroupDto

name

string

order

number

color

string

is_completion_group

boolean

Is Completion Group

archived

boolean

Archived

rollup

string

Rollup

TaskGroupGeneralResponse

message

string · required

Success message

MoveAllTasks

target

string · required

Target

InviteMember

email

string · required

role

string · required

Role

name

string

Name

InviteDto

InviteMember[] · required

List of members

TemplateResponseDto

ID

string · required

Name

string · required

Description

string · required

Template Type

string · required

Public Token

string · required

Created Date

string · date-time · required

Updated Date

string · date-time · required

Created by Team member Id

string · required

GetWebhooksDto

limit

number · required

No of records per page

Example: 25

offset

number · required

Record Offset

Example: 0

GetWebhooksResponse

webhooks

string[] · required

Webhook

hasMore

boolean · required

True if there are more record else false

Default: false

CreateWebhookDto

endpoint

string · required

Webhook Endpoint URL

event

string[] · required

Webhook events

Enum values:

projectCreated

projectRemoved

projectUpdated

taskCreated

taskRemoved

taskUpdated

portfolioCreated

portfolioRemoved

app_id

string · required

Application id

Webhook

CreateWebhookReponse

message

string · required

Operation message

webhook

object · required

Webhook

RemoveWebhookDto

app_id

string · required

Application ID

RemoveWebhookResponse

message

string · required

Operation message

webhook_id

string · required

Webhook ID

UpdateWebhookDto

endpoint

string · required

Webhook Endpoint URL

event

string[] · required

Webhook Event

Enum values:

projectCreated

projectRemoved

projectUpdated

taskCreated

taskRemoved

taskUpdated

portfolioCreated

portfolioRemoved

app_id

string · required

Application ID

UpdateWebhookResponse

message

string · required

Operation message

webhook_id

string · required

Updated webhook record id