List or filter tasks
List tasks that match the filters, newest first by default. total_results holds the number of matching tasks.
Without a _type or _type__in filter, only lead tasks are returned. Use _type=all to also return the other items in your Close inbox, such as incoming emails and missed calls. Use view for the inbox, future and archive views shown in Close.
Set format=ical to get the tasks as an iCalendar feed instead of JSON.
If you don’t have the “View All Leads” permission, results only include tasks on leads you can access. Filtering by your own assigned_to returns all of your tasks.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
Only return tasks assigned to this user, e.g. user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA. Returns 403 for another user if your role restricts which leads you can see.
Set to ical to get the tasks as an iCalendar (text/calendar) feed instead of JSON. Sending an Accept: text/calendar header does the same. The feed leaves out tasks with no due date.
Only return the task with this ID, e.g. task_aRUZXCm9lMb2LwipTPhfFoFbCsUnaoQh1ncQ7WLnjlI.
Comma-separated list of task IDs. Only return these tasks.
true to only return completed tasks, false to only return incomplete tasks.
Only return tasks on this lead, e.g. lead_5LmpOyrMQdJSUlbNGBSGfK5XzcioIm7aC94PSQamQJc.
Field to sort by: date, due_date, date_created or date_updated. Prefix with - to sort in descending order, e.g. -date. Defaults to -date_created.
Only return tasks of this type. Defaults to lead (tasks created on a lead) when neither _type nor _type__in is set. Use all to return every type.
Comma-separated list of task types, e.g. lead,outgoing_call. Only return tasks of any of these types. Takes the same values as _type, except all.
Shortcut for a task view. inbox returns incomplete tasks due by the end of today, future returns incomplete tasks due from tomorrow on, and archive returns completed tasks. Today is based on your time zone. inbox overrides is_complete and date__lt, future overrides is_complete and date__gte, and archive overrides is_complete.
Only return tasks due at exactly this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z. Values without a UTC offset are treated as UTC.
Only return tasks due before this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z. Values without a UTC offset are treated as UTC.
Only return tasks due on or before this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z. Values without a UTC offset are treated as UTC.
Only return tasks due after this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z. Values without a UTC offset are treated as UTC.
Only return tasks due on or after this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z. Values without a UTC offset are treated as UTC.
Deprecated: use date instead, which it matches.
Deprecated: use date__lt instead, which it matches.
Deprecated: use date__lte instead, which it matches.
Deprecated: use date__gt instead, which it matches.
Deprecated: use date__gte instead, which it matches.
Only return tasks created before this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Only return tasks created on or before this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Only return tasks created after this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Only return tasks created on or after this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Only return tasks last updated before this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Only return tasks last updated on or before this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Only return tasks last updated after this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Only return tasks last updated on or after this date or time, in ISO 8601, e.g. 2024-01-31 or 2024-01-31T09:00:00Z.
Comma-separated list of fields to include in the response.