Skip to main content
POST
Search tasks

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Body

application/json
offset
integer | null
default:0

Records to skip for pagination. Defaults to 0.

Required range: x >= 0
limit
integer
default:100

Max records per page (1–100). Defaults to 100.

Required range: 1 <= x <= 100
keywords
string[]

Search task content. Every word must match (all keywords combined with AND). Words match on their English stem, so "calling" also finds "called". Punctuation is ignored.

task_types
enum<string>[]

Filter by one or more task types.

Available options:
text,
linkedin_message,
linkedin_connection,
call,
other

UUID of the related entity (person, deal, client, or job). Must be paired with related_record_type.

Type of the related entity. Must be paired with related_to.

Available options:
person,
deal,
client,
job
is_completed
boolean

Filter by completion status. Open tasks for people who have left a campaign are omitted by default; completed ones still appear.

owner_ids
string<uuid>[]

Filter by assigned team member UUIDs. Returns tasks owned by any of these members. The owners list on each returned task only includes the members you filtered by. Get IDs from GET /v1/team-members.

due_date_start
string

ISO 8601 date — only include tasks due on or after this date. Tasks with no due date are excluded.

due_date_end
string

ISO 8601 date — only include tasks due on or before this date. Tasks with no due date are excluded.

sort_by
enum<string>
default:created_at

Column to sort by. One of: created_at (default), updated_at, due_date.

Available options:
created_at,
updated_at,
due_date
sort_order
enum<string>
default:desc

Sort direction. Defaults to desc.

Available options:
asc,
desc

Response

Tasks found

success
enum<boolean>
required
Available options:
true
data
object[]
required
meta
object
required