Tasks

List Tasks

List tasks

get

/v1/task/list

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

cursorstring

The cursor to use for pagination

orderstring

The order of the paginated items

takeinteger

The number of items to retrieve

botIdstring

Filter by associated bot

contactIdstring

Filter by associated contact

statusstring

Filter by task status

metaobject

Key-value pairs to filter the partner users by metadata


import { ChatBotKit } from '@chatbotkit/sdk'

const cbk = new ChatBotKit({
secret: process.env.CHATBOTKIT_API_KEY!
})

const response = await cbk.task.list(
)

{"items":[{"name":"string",
"description":"string",
"meta":"object",
"id":"string",
"createdAt":"number",
"updatedAt":"number",
"contactId":"string",
"botId":"string",
"schedule":"string",
"status":"string",
"outcome":"string"
}
]
}

The list of tasks was retrieved successfully

Go to cbk.ai