v1

latestOpenAPI 3.1.02026-08-069158174.8 KB
CRM Service Calls

Get Tasks

Retrieve tasks with optional filtering, sorting, and pagination.

Tasks represent actionable work items linked to CRM entities (leads, contacts, accounts, opportunities, etc.). Without filters, returns the most recent tasks sorted newest first.

Query Parameters:

  • match_filter_dict (optional): JSON-encoded MongoDB query. Filterable fields include: status, priority, action, subject_type, subject, userid, is_completed, due_date, tags. Examples:
    • {"status": "assigned"} — tasks in "assigned" status
    • {"priority": 1} — highest priority tasks
    • {"action": "call"} — call tasks only
    • {"subject_type": "lead", "subject": "64a856b9..."} — tasks linked to a specific lead Note: Use exact database field names only. Do not use pseudo-fields like created_at.
  • sort_dict (default: {"_id": -1}): JSON-encoded sort criteria. Example: {"due_date": 1} — sort by due date ascending.
  • page_size (default: 20): Number of records per page.
  • page_num (default: 1): Page number (1-indexed).

Response: Paginated object with tasks array, page_size, and page_num.

get/crm/tasks

Query parameters

match_filter_dictstring
sort_dictstring
page_sizeinteger
page_numinteger

Response

Successful Response

page_sizeinteger required
page_numinteger required