Tasks
Tasks are used on workspaces and can be connected to people, organizations, and conversations.
Good to know:
A task must always contain a title
A task must be part of a workspace
The type (task or deal) is determined by the workspace
Creates a Task resource.
https://example.com/
https://example.com/
https://example.com/
Title of task
Short description of task
Workspace
/workspaces/{workspaceId}/columns/{id}
Author of this task
/users/{id}
Assignees belonging to this task
["/users/{id}"]
Obersers belonging to this task
["/users/{id}"]
Highlight this task
Archive task
Date when this task is due
Task is a template
Date when task is scheduled
Date when task is planned in week
Date when task is planned in month
Snooze task until
Task resource created
Invalid input
Forbidden
An error occurred
POST /tasks HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 714
{
"parent": "https://example.com/",
"beforeTask": "https://example.com/",
"afterTask": "https://example.com/",
"positionTop": null,
"participants": [
"text"
],
"title": null,
"description": null,
"status": "/workspaces/{workspaceId}/columns/{id}",
"author": "/users/{id}",
"assignees": [
"/users/{id}"
],
"observers": [
"/users/{id}"
],
"tags": [
"/tags/{id}"
],
"people": [
"/people/{id}"
],
"organizations": [
"/organizations/{id}"
],
"messages": [
"/messages/{id}"
],
"conversationItems": [
"/conversations/{conversationId}/items/{id}"
],
"isFlagged": true,
"archivedAt": null,
"dueDate": null,
"isTemplate": true,
"storyPointEstimation": null,
"dealSizeEstimation": null,
"timeEstimation": null,
"scheduledOn": null,
"plannedWeek": null,
"plannedMonth": null,
"snoozeUntil": null
}
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"position": null,
"totalComments": null,
"title": null,
"description": null,
"isFlagged": null,
"isSubTask": null,
"indexNumber": null,
"createdAt": null,
"updatedAt": null,
"completedAt": null,
"archivedAt": null,
"dueDate": null,
"workspace": "https://example.com/",
"status": "https://example.com/",
"author": "https://example.com/",
"parent": "https://example.com/",
"tags": [
"https://example.com/"
],
"assignees": [
"https://example.com/"
],
"observers": [
"https://example.com/"
],
"subTasks": [
"https://example.com/"
],
"completedSubtasks": null,
"totalSubtasks": null,
"isTemplate": null,
"storyPointEstimation": null,
"timeEstimation": null,
"dealSizeEstimation": null,
"messageProvider": null,
"scheduledOn": null,
"previouslyScheduledOn": null,
"plannedWeek": null,
"plannedMonth": null,
"snoozeUntil": null,
"isRecurring": null,
"files": [
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"createdAt": null,
"name": null,
"size": null,
"mimeType": null,
"contentId": null,
"updatedAt": null,
"publicUrl": null
}
],
"messages": [
"text"
],
"conversationItems": [
"https://example.com/"
],
"people": [
"https://example.com/"
],
"organizations": [
"https://example.com/"
],
"recurringSettings": [
"text"
],
"automation": "https://example.com/",
"startDate": null,
"blockedFields": [
"text"
]
}
Creates a Task resource.
Task identifier
Duplicate task
Set status
/workspaces/{workspaceId}/columns/{id}
Title based on task to be copied
Task resource created
Invalid input
Forbidden
An error occurred
POST /tasks/{id}/duplicate HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 178
{
"status": "/workspaces/{workspaceId}/columns/{id}",
"title": "Title based on task to be copied",
"isTemplate": true,
"people": [
"/people/{id}"
],
"organizations": [
"/organizations/{id}"
]
}
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"position": null,
"totalComments": null,
"title": null,
"description": null,
"isFlagged": null,
"isSubTask": null,
"indexNumber": null,
"createdAt": null,
"updatedAt": null,
"completedAt": null,
"archivedAt": null,
"dueDate": null,
"workspace": "https://example.com/",
"status": "https://example.com/",
"author": "https://example.com/",
"parent": "https://example.com/",
"tags": [
"https://example.com/"
],
"assignees": [
"https://example.com/"
],
"observers": [
"https://example.com/"
],
"subTasks": [
"https://example.com/"
],
"completedSubtasks": null,
"totalSubtasks": null,
"isTemplate": null,
"storyPointEstimation": null,
"timeEstimation": null,
"dealSizeEstimation": null,
"messageProvider": null,
"scheduledOn": null,
"previouslyScheduledOn": null,
"plannedWeek": null,
"plannedMonth": null,
"snoozeUntil": null,
"isRecurring": null,
"files": [
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"createdAt": null,
"name": null,
"size": null,
"mimeType": null,
"contentId": null,
"updatedAt": null,
"publicUrl": null
}
],
"messages": [
"text"
],
"conversationItems": [
"https://example.com/"
],
"people": [
"https://example.com/"
],
"organizations": [
"https://example.com/"
],
"recurringSettings": [
"text"
],
"automation": "https://example.com/",
"startDate": null,
"blockedFields": [
"text"
]
}
Creates a TaskCommentResource resource.
TaskCommentResource identifier
https://example.com/
https://example.com/
TaskCommentResource resource created
Invalid input
Forbidden
An error occurred
POST /tasks/{taskId}/comments HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 144
{
"id": null,
"taskId": null,
"createdAt": null,
"description": null,
"flagged": null,
"author": "https://example.com/",
"mentions": [
"https://example.com/"
]
}
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"createdAt": null,
"description": null,
"flagged": null,
"author": "https://example.com/",
"mentions": [
"https://example.com/"
]
}
Retrieves a Task resource.
Task identifier
Task resource
Forbidden
Not found
GET /tasks/{id} HTTP/1.1
Host: api.rogerroger.io
Accept: */*
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"position": null,
"totalComments": null,
"title": null,
"description": null,
"isFlagged": null,
"isSubTask": null,
"indexNumber": null,
"createdAt": null,
"updatedAt": null,
"completedAt": null,
"archivedAt": null,
"dueDate": null,
"workspace": "https://example.com/",
"status": "https://example.com/",
"author": "https://example.com/",
"parent": "https://example.com/",
"tags": [
"https://example.com/"
],
"assignees": [
"https://example.com/"
],
"observers": [
"https://example.com/"
],
"subTasks": [
"https://example.com/"
],
"completedSubtasks": null,
"totalSubtasks": null,
"isTemplate": null,
"storyPointEstimation": null,
"timeEstimation": null,
"dealSizeEstimation": null,
"messageProvider": null,
"scheduledOn": null,
"previouslyScheduledOn": null,
"plannedWeek": null,
"plannedMonth": null,
"snoozeUntil": null,
"isRecurring": null,
"files": [
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"createdAt": null,
"name": null,
"size": null,
"mimeType": null,
"contentId": null,
"updatedAt": null,
"publicUrl": null
}
],
"messages": [
"text"
],
"conversationItems": [
"https://example.com/"
],
"people": [
"https://example.com/"
],
"organizations": [
"https://example.com/"
],
"recurringSettings": [
"text"
],
"automation": "https://example.com/",
"startDate": null,
"blockedFields": [
"text"
]
}
Retrieves a TaskCommentResource resource.
TaskCommentResource identifier
TaskCommentResource identifier
TaskCommentResource resource
Forbidden
Not found
GET /tasks/{taskId}/comments/{id} HTTP/1.1
Host: api.rogerroger.io
Accept: */*
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"createdAt": null,
"description": null,
"flagged": null,
"author": "https://example.com/",
"mentions": [
"https://example.com/"
]
}
Updates the TaskCommentResource resource.
TaskCommentResource identifier
TaskCommentResource identifier
https://example.com/
https://example.com/
TaskCommentResource resource updated
Invalid input
Forbidden
Not found
An error occurred
PATCH /tasks/{taskId}/comments/{id} HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 144
{
"id": null,
"taskId": null,
"createdAt": null,
"description": null,
"flagged": null,
"author": "https://example.com/",
"mentions": [
"https://example.com/"
]
}
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"createdAt": null,
"description": null,
"flagged": null,
"author": "https://example.com/",
"mentions": [
"https://example.com/"
]
}
Retrieves a TaskHistory resource.
TaskHistory identifier
TaskHistory identifier
TaskHistory resource
Forbidden
Not found
GET /tasks/{taskId}/history/{id} HTTP/1.1
Host: api.rogerroger.io
Accept: */*
{
"@id": "text",
"@type": "text",
"@context": "text",
"id": "text",
"createdAt": "2025-10-07T20:53:38.265Z",
"changes": [
"text"
],
"author": "https://example.com/"
}
Replaces the TaskCommentResource resource.
TaskCommentResource identifier
TaskCommentResource identifier
https://example.com/
https://example.com/
TaskCommentResource resource updated
Invalid input
Forbidden
Not found
An error occurred
PUT /tasks/{taskId}/comments/{id} HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 144
{
"id": null,
"taskId": null,
"createdAt": null,
"description": null,
"flagged": null,
"author": "https://example.com/",
"mentions": [
"https://example.com/"
]
}
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"createdAt": null,
"description": null,
"flagged": null,
"author": "https://example.com/",
"mentions": [
"https://example.com/"
]
}
Updates the UpdateTaskResource resource.
UpdateTaskResource identifier
Task is completed at
https://example.com/
Title of task
Short description of task
Workspace
/workspaces/{workspaceId}/columns/{id}
Author of this task
/users/{id}
Assignees belonging to this task
["/users/{id}"]
Obersers belonging to this task
["/users/{id}"]
Tags of this task
["/tags/{id}"]
People belonging to this task
["/people/{id}"]
Organizations belonging to this task
["/organizations/{id}"]
Messages belonging to this task
["/messages/{id}"]
Messages belonging to this task
["/conversations/{conversationId}/items/{id}"]
Highlight this task
Archive task
Date when this task is due
Task is a template
Date when task is scheduled
Date when task is planned in week
Date when task is planned in month
Snooze task until
UpdateTaskResource resource updated
Invalid input
Forbidden
Not found
An error occurred
PATCH /tasks/{id} HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 782
{
"completedAt": null,
"files": [
"https://example.com/"
],
"recurringSettings": {
"rrule": null,
"recurUntilCount": 1,
"recurUntil": null,
"recurOnSchedule": true,
"createNewTask": true,
"snooze": true,
"recurData": [
"text"
]
},
"id": null,
"title": null,
"description": null,
"status": "/workspaces/{workspaceId}/columns/{id}",
"author": "/users/{id}",
"assignees": [
"/users/{id}"
],
"observers": [
"/users/{id}"
],
"tags": [
"/tags/{id}"
],
"people": [
"/people/{id}"
],
"organizations": [
"/organizations/{id}"
],
"messages": [
"/messages/{id}"
],
"conversationItems": [
"/conversations/{conversationId}/items/{id}"
],
"isFlagged": true,
"archivedAt": null,
"dueDate": null,
"isTemplate": true,
"storyPointEstimation": null,
"dealSizeEstimation": null,
"timeEstimation": null,
"scheduledOn": null,
"plannedWeek": null,
"plannedMonth": null,
"snoozeUntil": null
}
{
"@context": "text",
"@id": "text",
"@type": "text",
"completedAt": null,
"files": [
"https://example.com/"
],
"recurringSettings": {
"@context": "text",
"@id": "text",
"@type": "text",
"rrule": null,
"recurUntilCount": 1,
"recurUntil": null,
"recurOnSchedule": true,
"createNewTask": true,
"snooze": true,
"recurData": [
"text"
]
},
"id": null,
"title": null,
"description": null,
"status": "/workspaces/{workspaceId}/columns/{id}",
"author": "/users/{id}",
"assignees": [
"/users/{id}"
],
"observers": [
"/users/{id}"
],
"tags": [
"/tags/{id}"
],
"people": [
"/people/{id}"
],
"organizations": [
"/organizations/{id}"
],
"messages": [
"/messages/{id}"
],
"conversationItems": [
"/conversations/{conversationId}/items/{id}"
],
"isFlagged": true,
"archivedAt": null,
"dueDate": null,
"isTemplate": true,
"storyPointEstimation": null,
"dealSizeEstimation": null,
"timeEstimation": null,
"scheduledOn": null,
"plannedWeek": null,
"plannedMonth": null,
"snoozeUntil": null
}
Replaces the UpdateTaskResource resource.
UpdateTaskResource identifier
Task is completed at
https://example.com/
Title of task
Short description of task
Workspace
/workspaces/{workspaceId}/columns/{id}
Author of this task
/users/{id}
Assignees belonging to this task
["/users/{id}"]
Obersers belonging to this task
["/users/{id}"]
Tags of this task
["/tags/{id}"]
People belonging to this task
["/people/{id}"]
Organizations belonging to this task
["/organizations/{id}"]
Messages belonging to this task
["/messages/{id}"]
Messages belonging to this task
["/conversations/{conversationId}/items/{id}"]
Highlight this task
Archive task
Date when this task is due
Task is a template
Date when task is scheduled
Date when task is planned in week
Date when task is planned in month
Snooze task until
UpdateTaskResource resource updated
Invalid input
Forbidden
Not found
An error occurred
PUT /tasks/{id} HTTP/1.1
Host: api.rogerroger.io
Content-Type: application/ld+json
Accept: */*
Content-Length: 782
{
"completedAt": null,
"files": [
"https://example.com/"
],
"recurringSettings": {
"rrule": null,
"recurUntilCount": 1,
"recurUntil": null,
"recurOnSchedule": true,
"createNewTask": true,
"snooze": true,
"recurData": [
"text"
]
},
"id": null,
"title": null,
"description": null,
"status": "/workspaces/{workspaceId}/columns/{id}",
"author": "/users/{id}",
"assignees": [
"/users/{id}"
],
"observers": [
"/users/{id}"
],
"tags": [
"/tags/{id}"
],
"people": [
"/people/{id}"
],
"organizations": [
"/organizations/{id}"
],
"messages": [
"/messages/{id}"
],
"conversationItems": [
"/conversations/{conversationId}/items/{id}"
],
"isFlagged": true,
"archivedAt": null,
"dueDate": null,
"isTemplate": true,
"storyPointEstimation": null,
"dealSizeEstimation": null,
"timeEstimation": null,
"scheduledOn": null,
"plannedWeek": null,
"plannedMonth": null,
"snoozeUntil": null
}
{
"@context": "text",
"@id": "text",
"@type": "text",
"completedAt": null,
"files": [
"https://example.com/"
],
"recurringSettings": {
"@context": "text",
"@id": "text",
"@type": "text",
"rrule": null,
"recurUntilCount": 1,
"recurUntil": null,
"recurOnSchedule": true,
"createNewTask": true,
"snooze": true,
"recurData": [
"text"
]
},
"id": null,
"title": null,
"description": null,
"status": "/workspaces/{workspaceId}/columns/{id}",
"author": "/users/{id}",
"assignees": [
"/users/{id}"
],
"observers": [
"/users/{id}"
],
"tags": [
"/tags/{id}"
],
"people": [
"/people/{id}"
],
"organizations": [
"/organizations/{id}"
],
"messages": [
"/messages/{id}"
],
"conversationItems": [
"/conversations/{conversationId}/items/{id}"
],
"isFlagged": true,
"archivedAt": null,
"dueDate": null,
"isTemplate": true,
"storyPointEstimation": null,
"dealSizeEstimation": null,
"timeEstimation": null,
"scheduledOn": null,
"plannedWeek": null,
"plannedMonth": null,
"snoozeUntil": null
}
Retrieves the collection of Task resources.
The collection page number
1
The number of items per page
15
Filter parameter to specify the view. To get only UUIDs, use 'idx'.
Task collection
Forbidden
GET /tasks HTTP/1.1
Host: api.rogerroger.io
Accept: */*
{
"member": [
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"position": null,
"totalComments": null,
"title": null,
"description": null,
"isFlagged": null,
"isSubTask": null,
"indexNumber": null,
"createdAt": null,
"updatedAt": null,
"completedAt": null,
"archivedAt": null,
"dueDate": null,
"workspace": "https://example.com/",
"status": "https://example.com/",
"author": "https://example.com/",
"parent": "https://example.com/",
"tags": [
"https://example.com/"
],
"assignees": [
"https://example.com/"
],
"observers": [
"https://example.com/"
],
"subTasks": [
"https://example.com/"
],
"completedSubtasks": null,
"totalSubtasks": null,
"isTemplate": null,
"storyPointEstimation": null,
"timeEstimation": null,
"dealSizeEstimation": null,
"messageProvider": null,
"scheduledOn": null,
"previouslyScheduledOn": null,
"plannedWeek": null,
"plannedMonth": null,
"snoozeUntil": null,
"isRecurring": null,
"files": [
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"createdAt": null,
"name": null,
"size": null,
"mimeType": null,
"contentId": null,
"updatedAt": null,
"publicUrl": null
}
],
"messages": [
"text"
],
"conversationItems": [
"https://example.com/"
],
"people": [
"https://example.com/"
],
"organizations": [
"https://example.com/"
],
"recurringSettings": [
"text"
],
"automation": "https://example.com/",
"startDate": null,
"blockedFields": [
"text"
]
}
],
"totalItems": 1,
"view": {
"@id": "string",
"type": "string",
"first": "string",
"last": "string",
"previous": "string",
"next": "string"
},
"search": {
"@type": "text",
"template": "text",
"variableRepresentation": "text",
"mapping": [
{
"@type": "text",
"variable": "text",
"property": null,
"required": true
}
]
}
}
Retrieves the collection of TaskCommentResource resources.
TaskCommentResource identifier
The collection page number
1
The number of items per page
15
TaskCommentResource collection
Forbidden
GET /tasks/{taskId}/comments HTTP/1.1
Host: api.rogerroger.io
Accept: */*
{
"member": [
{
"@context": "text",
"@id": "text",
"@type": "text",
"id": null,
"createdAt": null,
"description": null,
"flagged": null,
"author": "https://example.com/",
"mentions": [
"https://example.com/"
]
}
],
"totalItems": 1,
"view": {
"@id": "string",
"type": "string",
"first": "string",
"last": "string",
"previous": "string",
"next": "string"
},
"search": {
"@type": "text",
"template": "text",
"variableRepresentation": "text",
"mapping": [
{
"@type": "text",
"variable": "text",
"property": null,
"required": true
}
]
}
}
Retrieves the collection of TaskHistory resources.
TaskHistory identifier
The collection page number
1
The number of items per page
15
asc
Possible values: TaskHistory collection
Forbidden
GET /tasks/{taskId}/history HTTP/1.1
Host: api.rogerroger.io
Accept: */*
{
"member": [
{
"@id": "text",
"@type": "text",
"@context": "text",
"id": "text",
"createdAt": "2025-10-07T20:53:38.265Z",
"changes": [
"text"
],
"author": "https://example.com/"
}
],
"totalItems": 1,
"view": {
"@id": "string",
"type": "string",
"first": "string",
"last": "string",
"previous": "string",
"next": "string"
},
"search": {
"@type": "text",
"template": "text",
"variableRepresentation": "text",
"mapping": [
{
"@type": "text",
"variable": "text",
"property": null,
"required": true
}
]
}
}
Last updated