New to Corsair? See API access, authentication, and error handling.
Account
get
account.get
Read the account, including the virtual root folder id that a task or folder create needs as its parent
Risk: read
await corsair.wrike.api.account.get({});
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
name?: string | null,
dateFormat?: string | null,
firstDayOfWeek?: string | null,
workDays?: string[] | null,
rootFolderId?: string | null,
recycleBinId?: string | null,
timezone?: string | null,
locale?: string | null,
subscription?: Record<string, any> | null
}[] | null
Comments
create
comments.create
Post a comment on a task
Risk: write
await corsair.wrike.api.comments.create({ taskId: 'IEAAABCDEF12345', text: 'Looks good to me.' });
| Name | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | — |
text | string | Yes | The comment text, sent as plain text: Wrike strips any HTML tags rather than rendering them. |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
text?: string | null,
authorId?: string | null,
type?: string | null,
createdDate?: string | null,
updatedDate?: string | null,
taskId?: string | null,
folderId?: string | null,
rootCommentId?: string | null
}[] | null
delete
comments.delete
Delete a comment
Risk: destructive
await corsair.wrike.api.comments.delete({ id: 'CMABCDEF12345' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
deleted | true | Yes | — |
list
comments.list
List comments across the account, up to a limit
Risk: read
await corsair.wrike.api.comments.list({ limit: 100 });
| Name | Type | Required | Description |
|---|---|---|---|
limit | number | No | The most comments to return. Wrike returns up to 1000 by default. |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
text?: string | null,
authorId?: string | null,
type?: string | null,
createdDate?: string | null,
updatedDate?: string | null,
taskId?: string | null,
folderId?: string | null,
rootCommentId?: string | null
}[] | null
task
comments.task
List the comments on a task
Risk: read
await corsair.wrike.api.comments.task({ taskId: 'IEAAABCDEF12345' });
| Name | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
text?: string | null,
authorId?: string | null,
type?: string | null,
createdDate?: string | null,
updatedDate?: string | null,
taskId?: string | null,
folderId?: string | null,
rootCommentId?: string | null
}[] | null
update
comments.update
Edit the text of a comment you wrote; Wrike allows it only in the 5 minutes after posting
Risk: write
await corsair.wrike.api.comments.update({ id: 'CMABCDEF12345', text: 'Edited.' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
text | string | Yes | Plain text, as on create. Wrike allows an edit only in the 5 minutes after posting. |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
text?: string | null,
authorId?: string | null,
type?: string | null,
createdDate?: string | null,
updatedDate?: string | null,
taskId?: string | null,
folderId?: string | null,
rootCommentId?: string | null
}[] | null
Contacts
get
contacts.get
Read one contact by id, or me for the one behind the token
Risk: read
await corsair.wrike.api.contacts.get({ id: 'me' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | A contact id, or me for the contact behind the token. |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
firstName?: string | null,
lastName?: string | null,
primaryEmail?: string | null,
title?: string | null,
companyName?: string | null,
phone?: string | null,
location?: string | null,
timezone?: string | null,
locale?: string | null,
type?: string | null,
avatarUrl?: string | null,
deleted?: boolean | null,
me?: boolean | null,
myTeam?: boolean | null,
profiles?: Record<string, any>[] | null
}[] | null
list
contacts.list
List the contacts on the account, optionally only active ones or only yourself
Risk: read
await corsair.wrike.api.contacts.list({ active: true });
| Name | Type | Required | Description |
|---|---|---|---|
me | boolean | No | Only the contact behind the token. |
active | boolean | No | Only contacts who have not been deleted. |
fields | string | No | A JSON array of optional fields to include, e.g. ["attachmentCount"]. |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
firstName?: string | null,
lastName?: string | null,
primaryEmail?: string | null,
title?: string | null,
companyName?: string | null,
phone?: string | null,
location?: string | null,
timezone?: string | null,
locale?: string | null,
type?: string | null,
avatarUrl?: string | null,
deleted?: boolean | null,
me?: boolean | null,
myTeam?: boolean | null,
profiles?: Record<string, any>[] | null
}[] | null
Folders
create
folders.create
Create a folder inside another, or in the account root when given its virtual root id
Risk: write
await corsair.wrike.api.folders.create({ parentId: 'IEAABCDEF12345', title: 'Checkout revamp' });
| Name | Type | Required | Description |
|---|---|---|---|
parentId | string | Yes | The parent folder id. Use the Root Folder API id for the account root. |
title | string | Yes | — |
description | string | No | — |
shareds | string[] | No | Contact ids to share with. |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
title?: string | null,
childIds?: string[] | null,
scope?: string | null,
space?: boolean | null,
color?: string | null,
customItemTypeId?: string | null,
project?: {
status?: string | null,
ownerIds?: string[] | null,
startDate?: string | null,
endDate?: string | null,
createdDate?: string | null,
completedDate?: string | null
} | null
}[] | null
delete
folders.delete
Move a folder and every folder and task inside it to the recycle bin unless they have parents outside the deleted folder; Wrike does not refuse a folder with contents
Risk: destructive
await corsair.wrike.api.folders.delete({ id: 'IEAABCDEF12345' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
deleted | true | Yes | — |
get
folders.get
Read one folder or project
Risk: read
await corsair.wrike.api.folders.get({ id: 'IEAABCDEF12345' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
title?: string | null,
childIds?: string[] | null,
scope?: string | null,
space?: boolean | null,
color?: string | null,
customItemTypeId?: string | null,
project?: {
status?: string | null,
ownerIds?: string[] | null,
startDate?: string | null,
endDate?: string | null,
createdDate?: string | null,
completedDate?: string | null
} | null
}[] | null
list
folders.list
List folders and projects, each with its parent and scope
Risk: read
await corsair.wrike.api.folders.list({ project: true, pageSize: 100 });
| Name | Type | Required | Description |
|---|---|---|---|
pageSize | number | No | Items per page, up to 1000. |
nextPageToken | string | No | The token the previous page returned, to read the next. |
project | boolean | No | Only projects (true) or only plain folders (false). |
title | string | No | A substring of the title. |
permalink | string | No | A folder permalink, exact match. |
fields | string | No | A JSON array of optional fields to include, e.g. ["attachmentCount"]. |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
title?: string | null,
childIds?: string[] | null,
scope?: string | null,
space?: boolean | null,
color?: string | null,
customItemTypeId?: string | null,
project?: {
status?: string | null,
ownerIds?: string[] | null,
startDate?: string | null,
endDate?: string | null,
createdDate?: string | null,
completedDate?: string | null
} | null
}[] | null
tasks
folders.tasks
List the tasks in a folder, optionally including every descendant folder
Risk: read
await corsair.wrike.api.folders.tasks({ id: 'IEAABCDEF12345', descendants: true });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The folder id. |
pageSize | number | No | Items per page, up to 1000. |
nextPageToken | string | No | The token the previous page returned, to read the next. |
descendants | boolean | No | Also search every descendant folder. |
sortField | Status | Importance | Title | StartFinishInterval | DueDate | CreatedDate | UpdatedDate | CompletedDate | LastAccessDate | No | — |
sortOrder | Asc | Desc | No | — |
fields | string | No | A JSON array of optional fields to include, e.g. ["attachmentCount"]. |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
title?: string | null,
description?: string | null,
status?: string | null,
importance?: string | null,
permalink?: string | null,
dates?: {
type?: string | null,
duration?: number | null,
start?: string | null,
due?: string | null
} | null,
parentIds?: string[] | null,
subTaskIds?: string[] | null,
superTaskIds?: string[] | null,
authorIds?: string[] | null,
responsibleIds?: string[] | null,
followerIds?: string[] | null,
sharedIds?: string[] | null,
hasAttachments?: boolean | null,
recurrent?: boolean | null,
createdDate?: string | null,
updatedDate?: string | null,
completedDate?: string | null,
customFields?: Record<string, any>[] | null
}[] | null
update
folders.update
Rename a folder, change its description or move it between parents
Risk: write
await corsair.wrike.api.folders.update({ id: 'IEAABCDEF12345', title: 'Renamed' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
title | string | No | — |
description | string | No | — |
addParents | string[] | No | — |
removeParents | string[] | No | — |
customFields | Record<string, any>[] | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
title?: string | null,
childIds?: string[] | null,
scope?: string | null,
space?: boolean | null,
color?: string | null,
customItemTypeId?: string | null,
project?: {
status?: string | null,
ownerIds?: string[] | null,
startDate?: string | null,
endDate?: string | null,
createdDate?: string | null,
completedDate?: string | null
} | null
}[] | null
Tasks
create
tasks.create
Create a task in a folder, with assignees, dates, custom fields and metadata; Wrike has no account-level create
Risk: write
await corsair.wrike.api.tasks.create({ folderId: 'IEAABCDEF12345', title: 'Ship the new checkout', importance: 'High' });
| Name | Type | Required | Description |
|---|---|---|---|
folderId | string | Yes | The parent folder id. Use the Root Folder API id for the account root. |
title | string | Yes | — |
description | string | No | — |
status | Active | Deferred | Completed | Cancelled | No | — |
importance | High | Low | Normal | No | — |
responsibles | string[] | No | Contact ids to assign. |
followers | string[] | No | — |
startDate | string | No | Shorthand for dates.start, as yyyy-MM-dd. |
dueDate | string | No | Shorthand for dates.due, as yyyy-MM-dd. |
dates | object | No | Wrike schedules a task through this object; startDate and dueDate are folded into it. |
parents | string[] | No | Additional parent folders, beyond the one in the path. |
superTasks | string[] | No | Parent task ids for a subtask. Use the Root Folder API id as folderId. |
customFields | Record<string, any>[] | No | — |
metadata | Record<string, any>[] | No | — |
dates full type
dates full type
{
type?: Backlog | Milestone | Planned,
start?: string,
due?: string,
duration?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
title?: string | null,
description?: string | null,
status?: string | null,
importance?: string | null,
permalink?: string | null,
dates?: {
type?: string | null,
duration?: number | null,
start?: string | null,
due?: string | null
} | null,
parentIds?: string[] | null,
subTaskIds?: string[] | null,
superTaskIds?: string[] | null,
authorIds?: string[] | null,
responsibleIds?: string[] | null,
followerIds?: string[] | null,
sharedIds?: string[] | null,
hasAttachments?: boolean | null,
recurrent?: boolean | null,
createdDate?: string | null,
updatedDate?: string | null,
completedDate?: string | null,
customFields?: Record<string, any>[] | null
}[] | null
delete
tasks.delete
Move a task to the recycle bin, which a later update with restore can undo
Risk: destructive
await corsair.wrike.api.tasks.delete({ id: 'IEAAABCDEF12345' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
deleted | true | Yes | — |
get
tasks.get
Read one task with its status, dates, assignees and custom fields
Risk: read
await corsair.wrike.api.tasks.get({ id: 'IEAAABCDEF12345' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The task id, including its IEAA prefix. |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
title?: string | null,
description?: string | null,
status?: string | null,
importance?: string | null,
permalink?: string | null,
dates?: {
type?: string | null,
duration?: number | null,
start?: string | null,
due?: string | null
} | null,
parentIds?: string[] | null,
subTaskIds?: string[] | null,
superTaskIds?: string[] | null,
authorIds?: string[] | null,
responsibleIds?: string[] | null,
followerIds?: string[] | null,
sharedIds?: string[] | null,
hasAttachments?: boolean | null,
recurrent?: boolean | null,
createdDate?: string | null,
updatedDate?: string | null,
completedDate?: string | null,
customFields?: Record<string, any>[] | null
}[] | null
list
tasks.list
Search tasks account-wide by title, status, dates, author or assignee, with paging and sorting
Risk: read
await corsair.wrike.api.tasks.list({ status: ['Active', 'Completed'], importance: 'High', pageSize: 50 });
| Name | Type | Required | Description |
|---|---|---|---|
pageSize | number | No | Items per page, up to 1000. |
nextPageToken | string | No | The token the previous page returned, to read the next. |
title | string | No | A substring of the title. |
status | (Active | Deferred | Completed | Cancelled)[] | No | — |
importance | High | Low | Normal | No | — |
startDate | string | No | A date, or a range as {start},{end}. |
dueDate | string | No | A date, or a range as {start},{end}. |
createdDate | string | No | — |
updatedDate | string | No | — |
completedDate | string | No | — |
authors | string[] | No | Contact ids: only tasks created by any of them. |
responsibles | string[] | No | Contact ids: only tasks assigned to any of them. |
permalink | string | No | A task permalink, exact match. |
type | Milestone | Backlog | Planned | No | — |
subTasks | boolean | No | Include subtasks in the scope. |
withInvitations | boolean | No | Include invitations in the shared and responsible id lists. |
sortField | Status | Importance | Title | StartFinishInterval | DueDate | CreatedDate | UpdatedDate | CompletedDate | LastAccessDate | No | — |
sortOrder | Asc | Desc | No | — |
fields | string | No | A JSON array of optional fields to include, e.g. ["attachmentCount"]. |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
title?: string | null,
description?: string | null,
status?: string | null,
importance?: string | null,
permalink?: string | null,
dates?: {
type?: string | null,
duration?: number | null,
start?: string | null,
due?: string | null
} | null,
parentIds?: string[] | null,
subTaskIds?: string[] | null,
superTaskIds?: string[] | null,
authorIds?: string[] | null,
responsibleIds?: string[] | null,
followerIds?: string[] | null,
sharedIds?: string[] | null,
hasAttachments?: boolean | null,
recurrent?: boolean | null,
createdDate?: string | null,
updatedDate?: string | null,
completedDate?: string | null,
customFields?: Record<string, any>[] | null
}[] | null
update
tasks.update
Change a task title, status, dates, assignees or followers, or restore it from the recycle bin
Risk: write
await corsair.wrike.api.tasks.update({ id: 'IEAAABCDEF12345', status: 'Completed' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
title | string | No | — |
description | string | No | — |
status | Active | Deferred | Completed | Cancelled | No | — |
importance | High | Low | Normal | No | — |
addResponsibles | string[] | No | — |
removeResponsibles | string[] | No | — |
addFollowers | string[] | No | — |
startDate | string | No | Shorthand for dates.start, as yyyy-MM-dd. |
dueDate | string | No | Shorthand for dates.due, as yyyy-MM-dd. |
dates | object | No | Reschedule the task; { type: "Backlog" } clears its dates. |
restore | boolean | No | Restore a task from the recycle bin. |
customFields | Record<string, any>[] | No | — |
dates full type
dates full type
{
type?: Backlog | Milestone | Planned,
start?: string,
due?: string,
duration?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
title?: string | null,
description?: string | null,
status?: string | null,
importance?: string | null,
permalink?: string | null,
dates?: {
type?: string | null,
duration?: number | null,
start?: string | null,
due?: string | null
} | null,
parentIds?: string[] | null,
subTaskIds?: string[] | null,
superTaskIds?: string[] | null,
authorIds?: string[] | null,
responsibleIds?: string[] | null,
followerIds?: string[] | null,
sharedIds?: string[] | null,
hasAttachments?: boolean | null,
recurrent?: boolean | null,
createdDate?: string | null,
updatedDate?: string | null,
completedDate?: string | null,
customFields?: Record<string, any>[] | null
}[] | null
Timelogs
create
timelogs.create
Log hours against a task for a tracked date, with a comment (Wrike requires one, which may be empty) and an optional category
Risk: write
await corsair.wrike.api.timelogs.create({ taskId: 'IEAAABCDEF12345', hours: 6.5, trackedDate: '2024-06-01', comment: 'Built the cart' });
| Name | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | — |
hours | number | Yes | — |
trackedDate | string | Yes | The day the work belongs to, as yyyy-MM-dd. |
comment | string | Yes | Wrike requires a comment on every time entry; it may be empty. |
categoryId | string | No | A timelog category id. |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
taskId?: string | null,
userId?: string | null,
hours?: number | null,
trackedDate?: string | null,
comment?: string | null,
billingType?: string | null,
createdDate?: string | null,
updatedDate?: string | null,
approvalStatus?: string | null,
lockStatus?: string | null,
categoryId?: string | null
}[] | null
delete
timelogs.delete
Delete a logged time entry
Risk: destructive
await corsair.wrike.api.timelogs.delete({ id: 'TLABCDEF12345' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
deleted | true | Yes | — |
list
timelogs.list
List the time logged on the account, filtered by tracked or created date, or only your own
Risk: read
await corsair.wrike.api.timelogs.list({ me: true, trackedDate: '2024-06-01,2024-06-30' });
| Name | Type | Required | Description |
|---|---|---|---|
pageSize | number | No | Items per page, up to 1000. |
nextPageToken | string | No | The token the previous page returned, to read the next. |
me | boolean | No | Only the time logged by the user behind the token. |
trackedDate | string | No | A date, or a range as {start},{end}. |
createdDate | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
taskId?: string | null,
userId?: string | null,
hours?: number | null,
trackedDate?: string | null,
comment?: string | null,
billingType?: string | null,
createdDate?: string | null,
updatedDate?: string | null,
approvalStatus?: string | null,
lockStatus?: string | null,
categoryId?: string | null
}[] | null
task
timelogs.task
List the time logged against one task
Risk: read
await corsair.wrike.api.timelogs.task({ taskId: 'IEAAABCDEF12345' });
| Name | Type | Required | Description |
|---|---|---|---|
taskId | string | Yes | — |
pageSize | number | No | Items per page, up to 1000. |
nextPageToken | string | No | The token the previous page returned, to read the next. |
| Name | Type | Required | Description |
|---|---|---|---|
kind | string | null | No | — |
data | object[] | null | No | — |
nextPageToken | string | null | No | Pass this back as nextPageToken to read the next page. |
responseSize | number | null | No | The total number of matches across every page. |
data full type
data full type
{
id?: string | null,
taskId?: string | null,
userId?: string | null,
hours?: number | null,
trackedDate?: string | null,
comment?: string | null,
billingType?: string | null,
createdDate?: string | null,
updatedDate?: string | null,
approvalStatus?: string | null,
lockStatus?: string | null,
categoryId?: string | null
}[] | null