GET
TypeScript client

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

Query Parameters

cursor
string

Opaque pagination cursor from a previous response (nextCursor/prevCursor). Omit for the first page.

limit
string

Page size as a positive integer string; defaults to 25, capped at 100.

q
string

Free-text search over task titles and descriptions (case-insensitive substring match). Omit or send an empty string for no text filter.

Maximum string length: 200
scheduled
enum<string>

Filter by due-date presence: 'true' returns only tasks WITH a due date, 'false' only tasks WITHOUT one. Omit for both. 'false' is the only way to select tasks with no due date, and combining it with dueBefore/dueAfter is rejected as contradictory.

Available options:
true,
false
status
enum<string>

Legacy compatibility filter. Prefer workflowStatusId for dynamic board columns.

Available options:
todo,
in_progress,
done
workflowStatusId
string<uuid>

Only return tasks assigned to this workspace task workflow status.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
assigneeUserId
string<uuid>

Only return tasks assigned to this team member (user id, as returned by the list team members endpoint).

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
contentItemId
string<uuid>

Only return tasks attached to this post (post id, as returned by the list posts endpoint).

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
dueBefore
string

ISO-8601 inclusive upper bound on the due date. Tasks without a due date are excluded when either due bound is set.

dueAfter
string

ISO-8601 inclusive lower bound on the due date. Tasks without a due date are excluded when either due bound is set.

Response

Success

data
object[]
required
total
number
required
nextCursor
string | null
required
prevCursor
string | null
required