GET
/
tasks
{
  "tasks": [
    {
      "id": "019440e0-781a-7527-aa61-bff6e8bb2b52",
      "automatic": false,
      "type": "phone_call",
      "status": "scheduled",
      "due_on": "2025-01-07T11:07:20Z",
      "finished_on": null,
      "notes": null,
      "sequence_key": null,
      "sequence_name": null,
      "user_id": "019440e0-7803-7cc1-bcf8-9748f4f39c16",
      "user_email": "user@example.com",
      "contact": null
    }
  ],
  "_links": {
    "self": {
      "href": "/tasks?page[size]=20&user_id=019440e0-7803-7cc1-bcf8-9748f4f39c16"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Authorization
string
required

Query Parameters

​
page[size]
string

Page size

​
page[after]
string

Page after

​
page[before]
string

Page before

​
automatic
boolean

Filter by task automation type

​
type
string

Filter by task type

​
status
string

Filter by task status

​
contact_local_time_from
integer

Filter by associated contact local time hour being higher than this value

Required range: 0 < x < 23
​
contact_local_time_to
integer

Filter by associated contact local time hour being lower than this value

Required range: 0 < x < 23
​
message_opens
integer

Filter by associated message opens

Required range: x > 0
​
keyword
string

Filter by name, email or company associated with task

​
sequence_key
string

Filter by associated sequence

​
user_id
string
required

Filter by user

Response

200 - application/vnd.amp+json
​
_links
object
​
tasks
object[]

Was this page helpful?

List task typesSkip task