Get tasks

GET

/api/v1/tasks

Retrieve the tasks for a website. Tasks are work items the Unless platform creates for the account team, such as knowledge suggestions from the AI, detected knowledge gaps, flagged conversations to review, and sales or retention signals.

Use cases

• Account investigation: List open tasks to understand what needs attention on an account
• Task triage: Fetch tasks before updating their state or assignee with the update endpoint
• Reporting: Count tasks per state to summarise the account’s backlog

Notes

• websiteId is required as a query parameter and should match the x-website-id header
• Filter on state (open, done or deleted) to reduce the result set, tasks of every state are returned otherwise
• Tasks are sorted by updatedAt, most recent first

Parameters

Header Parameters

x-api-key

required

string

Your API key from account settings.

x-user-email

required

string

The email address of your user.

x-account-id

required

string

The ID of your account. You can find this in the account settings.

x-website-id

required

string

The ID of the workspace you want to use.

Query Parameters

websiteId

required

string

The website to list tasks for.

state

string

Allowed values: open done deleted

Only return tasks in this state.

Responses

200

The matching tasks with a total count.

object

tasks

Array<object>

object

accountId

The account ID that owns this task.

string

taskId

Unique identifier for this task.

string

name

Short title of the task.

string

description

Longer explanation of what the task is about.

string

nullable

type

The kind of work this task represents.

string

Allowed values: knowledge-suggestion knowledge-gap-detected review-flagged-conversation new-sales-opportunity retention-warning sales-expansion-opportunity wiki-suggestion maturity-task

source

Where the task originated.

string

Allowed values: team-assistant ai dashboard ingestion slack

state

Current state of the task.

string

Allowed values: open done deleted

data

Arbitrary structured payload attached to the task, depends on the task type.

object

assignee

Email address of the user the task is assigned to.

string

nullable

websiteId

The website this task belongs to.

string

nullable

createdAt

Unix timestamp (ms) when the task was created.

number

updatedAt

Unix timestamp (ms) when the task was last updated.

number

count

integer

Example

{
  "tasks": [
    {
      "accountId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "taskId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "Add a refund policy article",
      "description": "Several visitors asked about refunds and the AI had no source to answer from.",
      "type": "knowledge-gap-detected",
      "source": "ai",
      "state": "open",
      "websiteId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "createdAt": 1640995200000,
      "updatedAt": 1641081600000
    }
  ],
  "count": 1
}

400

Bad request - missing websiteId.

401

Unauthorized - invalid API key.