Skip to main content

List Tasks

Paginated task history for a single lead — both open (PENDING) and completed (COMPLETE) tasks, sorted by creation date (newest first).

Authentication Required

Requires the x-api-key header. See Overview for details.

HTTP Request

GET /enterprise/api/lead/:lead_id/task

Path Parameters

ParameterTypeRequiredDescription
lead_idnumberYesInternal lead ID. Get this from Get Lead.

Query Parameters

ParameterTypeRequiredDefaultDescription
pagenumberNo1Page number — starts at 1, not 0
page_sizenumberNo20Items per page. Maximum is 20 — larger values return 400.

Try it

Loading playground…

Code Examples

curl -X GET "https://prod-api.superfone.co.in/superfone/enterprise/api/lead/12345/task?page=1&page_size=20" \
-H "x-api-key: your_api_key_here"

Success Response

Status Code: 200 OK

{
"data": {
"rows": [
{
"id": 4567,
"org_id": 42,
"customer_id": 12345,
"title": "Follow up on pricing",
"type": "FOLLOW_UP_CALL",
"due_date": "2026-05-20T15:00:00.000Z",
"notify_at": "2026-05-20T14:50:00.000Z",
"notify": true,
"task_status": "PENDING",
"status": "ACTIVE",
"assignee_user_id": 678,
"created_by": 1,
"updated_by": null,
"created_at": "2026-05-19T08:30:00.000Z",
"updated_at": "2026-05-19T08:30:00.000Z"
},
{
"id": 4521,
"org_id": 42,
"customer_id": 12345,
"title": "Initial intro call",
"type": "FIRST_CALL",
"due_date": "2026-05-15T10:00:00.000Z",
"notify_at": "2026-05-15T10:00:00.000Z",
"notify": true,
"task_status": "COMPLETE",
"status": "COMPLETE",
"assignee_user_id": 678,
"created_by": 678,
"updated_by": 678,
"created_at": "2026-05-14T09:00:00.000Z",
"updated_at": "2026-05-15T10:30:00.000Z"
}
],
"total_pages": 1,
"current_page": 1,
"page_size": 20,
"total_items": 2
},
"message": "success"
}

Response Fields

FieldTypeDescription
data.rows[].idnumberInternal task ID
data.rows[].customer_idnumberThe lead this task belongs to
data.rows[].titlestring | nullTask title
data.rows[].typestringTask type (FOLLOW_UP_CALL, FIRST_CALL, REMINDER, etc.)
data.rows[].due_datestringISO 8601
data.rows[].notify_atstringISO 8601
data.rows[].notifybooleanWhether assignee notifications are enabled
data.rows[].task_statusstringPENDING or COMPLETE
data.rows[].assignee_user_idnumber | nullAssigned team member
data.rows[].created_atstringISO 8601
data.rows[].updated_atstringISO 8601
data.total_pagesnumberTotal pages available
data.current_pagenumberPage number returned
data.page_sizenumberItems per page
data.total_itemsnumberTotal matching tasks across all pages

Error Responses

StatusMessageWhen it occurs
400lead_id must be a numberURL contains a non-numeric :lead_id
400page_size must be a positive integerpage_size query param is missing a valid number (e.g. page_size=abc or page_size=0)
400page_size cannot exceed 20page_size query param is greater than 20. Use 20 or smaller.
401UnAuthorized, Please Provide Valid API KeyMissing or invalid x-api-key
404Lead not foundlead_id doesn't exist, or belongs to a different account