Open App

Tasks

Manage tasks linked to contacts or deals. No subscription add-on required.

List tasks

GET /v1/tasks

All results are filtered to activity_type = Task automatically.

Query parameters

Parameter Type Description
pageSize integer Results per page (default 10, max 100)
pageIndex integer Zero-based page index (default 0)
search string Search by task title
status integer 0=Open 1=In Progress 2=Completed 3=Cancelled 4=No Show
priority integer 0=None 1=Low 2=Medium 3=High 4=Urgent
assigned_user_id integer Filter by assigned user
due_date_from date Filter tasks due on or after (YYYY-MM-DD)
due_date_to date Filter tasks due on or before (YYYY-MM-DD)
sortBy string Field to sort by
sortOrder string asc | desc

Example response

{
  "success": true,
  "data": {
    "data": [
      {
        "activity_id": 15,
        "title": "Follow up with Sarah",
        "activity_type": "Task",
        "status": 0,
        "priority": 2,
        "start_datetime": "2026-07-15T10:00:00",
        "end_datetime": "2026-07-15T11:00:00",
        "cstid": 10
      }
    ],
    "current_page": 1,
    "total_records": 12,
    "total_pages": 2
  }
}

Get a task

GET /v1/tasks/{id}
Parameter Description
id The activity_id of the task

Create a task

POST /v1/tasks
Content-Type: application/json

activity_type is automatically set to Task — you do not need to include it.

Request body

Field Type Required Description
title string yes Task title (max 150 chars)
start_datetime datetime yes Start date and time (YYYY-MM-DDTHH:MM:SS)
deal_id integer **yes*** Link to a deal (deal_id)
cstid integer **yes*** Link to a contact (cstid)
end_datetime datetime no End date and time
description string no Task description
priority integer no 0–4 (default 2 = Medium)
status integer no 0–4 (default 0 = Open)
assigned_user_id integer no User ID to assign the task to
tags integer[] no Array of tag IDs

* At least one of deal_id or cstid is required.

Example request

{
  "title": "Follow up with Sarah",
  "start_datetime": "2026-07-15T10:00:00",
  "end_datetime": "2026-07-15T11:00:00",
  "cstid": 10,
  "priority": 3,
  "description": "Discuss contract renewal terms"
}

Example response

{
  "success": true,
  "message": "Task activity created successfully.",
  "data": {
    "activity_id": 15,
    "title": "Follow up with Sarah",
    "activity_type": "Task"
  }
}
← PreviousDealsNext →Estimates