Tasks

List Tasks

Retrieve list of tasks.

GET/workspaces/{workspaceId}/tasks

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200422

OK

Body

application/json

results*array of Task (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tasks', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200422

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "email",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "title": "text",
      "description": "text",
      "startsAt": "2024-12-21T12:21:35.540Z",
      "endsAt": "2024-12-21T12:21:35.540Z",
      "contacts": [
        {
          "refs": [
            {
              "key": "emailaddress",
              "value": "text"
            }
          ],
          "addedAt": "2024-12-21T12:21:35.540Z"
        }
      ],
      "createdBy": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "user"
      },
      "updatedBy": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "user"
      },
      "createdAt": "2024-12-21T12:21:35.540Z",
      "updatedAt": "2024-12-21T12:21:35.540Z",
      "originator": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "rootItem"
      }
    }
  ],
  "nextPageToken": "text"
}

Create Task

Add a new task to a workspace.

POST/workspaces/{workspaceId}/tasks

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

title*string

The title of the task.

typeenum

emailcallother

descriptionstring

The description of the task.

startsAtstring (date-time)

If specified, when to initiate the task.

endsAtstring (date-time)

If specified, the deadline for the task.

contactsarray of CreateTaskContact (object)

References to contacts involved in the task.

originatornullable object

The entity that originated the task.

rootItemobject

Properties to set on the root item after task creation.

Response

201404422

Successfully created

Body

application/json

id*string (uuid)

type*enum

emailcallother

workspaceIdstring (uuid)

title*string

The title of the task.

description*string

The title of the task.

startsAtstring (date-time)

If present, determines to initiate the task.

endsAtstring (date-time)

If present, determines the deadline for the task.

contactsarray of TaskContact (object)

createdByTaskActor (object)

updatedByTaskActor (object)

createdAt*string (date-time)

updatedAt*string (date-time)

originatorobject

The entity that originated the task.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tasks', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text"
    }),
});
const data = await response.json();

Response

201404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "email",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "description": "text",
  "startsAt": "2024-12-21T12:21:35.540Z",
  "endsAt": "2024-12-21T12:21:35.540Z",
  "contacts": [
    {
      "refs": [
        {
          "key": "emailaddress",
          "value": "text"
        }
      ],
      "addedAt": "2024-12-21T12:21:35.540Z"
    }
  ],
  "createdBy": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "user"
  },
  "updatedBy": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "user"
  },
  "createdAt": "2024-12-21T12:21:35.540Z",
  "updatedAt": "2024-12-21T12:21:35.540Z",
  "originator": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "rootItem"
  }
}

Get Task

Retrieve information about a specific task.

GET/workspaces/{workspaceId}/tasks/{taskId}

Authorization

useraccessKey

Path parameters

workspaceId*string

taskId*string (uuid)

Response

200404

ok

Body

application/json

id*string (uuid)

type*enum

emailcallother

workspaceIdstring (uuid)

title*string

The title of the task.

description*string

The title of the task.

startsAtstring (date-time)

If present, determines to initiate the task.

endsAtstring (date-time)

If present, determines the deadline for the task.

contactsarray of TaskContact (object)

createdByTaskActor (object)

updatedByTaskActor (object)

createdAt*string (date-time)

updatedAt*string (date-time)

originatorobject

The entity that originated the task.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tasks/{taskId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "email",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "description": "text",
  "startsAt": "2024-12-21T12:21:35.540Z",
  "endsAt": "2024-12-21T12:21:35.540Z",
  "contacts": [
    {
      "refs": [
        {
          "key": "emailaddress",
          "value": "text"
        }
      ],
      "addedAt": "2024-12-21T12:21:35.540Z"
    }
  ],
  "createdBy": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "user"
  },
  "updatedBy": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "user"
  },
  "createdAt": "2024-12-21T12:21:35.540Z",
  "updatedAt": "2024-12-21T12:21:35.540Z",
  "originator": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "rootItem"
  }
}

Update Task

Modify fields of a specific task.

PATCH/workspaces/{workspaceId}/tasks/{taskId}

Authorization

useraccessKey

Path parameters

workspaceId*string

taskId*string (uuid)

Body

application/json

typeenum

emailcallother

titlestring

The title of the task.

descriptionstring

The description of the task.

startsAtnullable string (date-time)

If specified, when to initiate the task. If null, startsAt will be removed.

endsAtnullable string (date-time)

If specified, the deadline for the task. If null, endsAt will be removed.

contactsarray of CreateTaskContact (object)

Replaces all contacts in the task. Either contacts or addContact should be specified, not both

addContactCreateTaskContact (object)

Response

200404422

Successfully updated

Body

application/json

id*string (uuid)

type*enum

emailcallother

workspaceIdstring (uuid)

title*string

The title of the task.

description*string

The title of the task.

startsAtstring (date-time)

If present, determines to initiate the task.

endsAtstring (date-time)

If present, determines the deadline for the task.

contactsarray of TaskContact (object)

createdByTaskActor (object)

updatedByTaskActor (object)

createdAt*string (date-time)

updatedAt*string (date-time)

originatorobject

The entity that originated the task.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/tasks/{taskId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "email",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "description": "text",
  "startsAt": "2024-12-21T12:21:35.540Z",
  "endsAt": "2024-12-21T12:21:35.540Z",
  "contacts": [
    {
      "refs": [
        {
          "key": "emailaddress",
          "value": "text"
        }
      ],
      "addedAt": "2024-12-21T12:21:35.540Z"
    }
  ],
  "createdBy": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "user"
  },
  "updatedBy": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "user"
  },
  "createdAt": "2024-12-21T12:21:35.540Z",
  "updatedAt": "2024-12-21T12:21:35.540Z",
  "originator": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "rootItem"
  }
}