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-10-13T00:22:51.720Z",
      "endsAt": "2024-10-13T00:22:51.720Z",
      "contacts": [
        {
          "refs": [
            {
              "key": "emailaddress",
              "value": "text"
            }
          ],
          "addedAt": "2024-10-13T00:22:51.720Z"
        }
      ],
      "createdBy": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "user"
      },
      "updatedBy": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "user"
      },
      "createdAt": "2024-10-13T00:22:51.720Z",
      "updatedAt": "2024-10-13T00:22:51.720Z",
      "originator": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "rootItem"
      }
    }
  ],
  "nextPageToken": "text"
}

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-10-13T00:22:51.720Z",
  "endsAt": "2024-10-13T00:22:51.720Z",
  "contacts": [
    {
      "refs": [
        {
          "key": "emailaddress",
          "value": "text"
        }
      ],
      "addedAt": "2024-10-13T00:22:51.720Z"
    }
  ],
  "createdBy": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "user"
  },
  "updatedBy": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "user"
  },
  "createdAt": "2024-10-13T00:22:51.720Z",
  "updatedAt": "2024-10-13T00:22:51.720Z",
  "originator": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "rootItem"
  }
}