Tasks

List, fetch, search, and update Tasks through the REST API — including the beta Update endpoint's field constraints and per-step overrides.

Published 2026/08/26

Requires the List tasks permission to read, Update tasks to write. See REST API Reference for the shared mode, pagination, and List/Fetch/Search conventions used below.

Basic vs. Detailed

basic — taskId, title, createdAt
detailed — adds organizationId, favorite, folder, labels, tags, lang, accessMethod, active, activeAfter, activeBefore, steps[], programs[], stages[], emailTemplates[], privateChatEnabled. Each step includes its own title, active, activeAfter/Before, attemptLimit, and the test it references.

List, Fetch, Search

GET /tasks — query params: mode, limit, page, title (case-insensitive partial match).
GET /tasks/:id — query param: mode.
POST /tasks/filter — query params: mode, limit, page; body: { folder?, labels?, favorite?, title? }, all AND-combined.

Update (Beta)

This endpoint is in beta — its request and response shape may change.

PATCH /tasks/:id — body:

fields — any of title, active, activeBefore, activeAfter, lang, favorite, folder, plus labels: { add?, remove? }. title, folder, and label values must be at least 2 characters and cannot contain <, >, or /.
steps — optional, keyed by step ID: { title?, active?, activeBefore?, activeAfter?, attemptLimit? }. Set attemptLimit: -1 for unlimited attempts.
activeBefore/activeAfter accept a Unix timestamp in seconds, or null to clear the restriction.

Returns the full detailed task object.