Call tasks
GET
/call-tasks

The call tasks campaigns' call steps made for the team, newest first. Defaults to status pending (waiting for a call); pass status=all for every status. A task stays pending until someone logs the call (done), skips it (skipped) or stops the lead's sequence from it (stopped), or until it runs out at dueAt (expired), and the lead then moves on. It is closed when the lead left the step on its own: a reply, a pause, the campaign paused or deleted, or the lead removed (closedReason says which). call_task.pending fires when a task is made.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Query Parameters

status?string

Value in

  • "pending"
  • "done"
  • "skipped"
  • "stopped"
  • "expired"
  • "closed"
  • "all"
campaignId?string
limit?integer

Page size, 1–100.

Range1 <= value <= 100
Default50
offset?integer

Number of records to skip.

Range0 <= value
Default0

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/call-tasks"
{  "data": [    {      "id": "string",      "status": "pending",      "lead": {        "id": "string",        "name": "string",        "profileUrl": "string",        "phone": "string",        "email": "string"      },      "campaign": {        "id": "string",        "name": "string"      },      "stepId": "string",      "instructions": "string",      "dueAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "outcome": "reached",      "note": "string",      "decidedAt": "2019-08-24T14:15:22Z",      "closedReason": "string"    }  ],  "paging": {    "limit": 0,    "offset": 0  }}