Tasks
Supported task attributes:
Attribute | Type | Description |
---|---|---|
id |
number | Unique identifier of the task. |
creator_id |
number | Unique identifier of the user who created the task. |
owner_id |
number | Unique identifier of the user the task is assigned to. |
completed |
boolean | Indicator of whether the task is completed or not. |
completed_at |
string | Date and time of the task’s completion in UTC (ISO8601 format). |
content |
string | Content of the task. |
resource_type |
string | Name of the resource type the task is attached to. |
resource_id |
number | Unique identifier of the resource the task is attached to. |
reminder_offset |
number | Reminder offset from due_date in minutes. |
due_date |
string | Date and time on which task falls due in UTC (ISO8601 format). |
created_at |
string | Date and time of task creation in UTC (ISO8601 format). |
Endpoints
Stream Tasks
Read the stream of task events.
See theFirehose Overviewarticle for more details on request and response formats and parameters.
Action
GET /v3/tasks/stream
Examples
Read the stream of task events
GET /v3/tasks/stream?position=tail
Accept: application/json
Authorization: Bearer $ACCESS_TOKEN
User-Agent: $CLIENT_NAME
HTTP/1.1200OK
Content-Type:application/json
{
"items":[
{
"data":{
"completed_at":null,
"account_id":88199,
"owner_id":113859,
"creator_id":113859,
"resource_type":"lead",
"due_date":"2017-11-02T13:00:00Z",
"resource_id":254952965,
"created_at":"2017-11-02T11:35:35Z",
"completed":false,
"id":1397004,
"reminder_offset":60,
"content":"fd"
},
"meta":{
"event_cause":"interaction",
"sequence":1,
"event_id":"sYf9BnVkS7mM74dq6RBpxQ",
"event_type":"created",
"type":"task",
"event_time":"2017-11-02T11:35:35Z"
}
}
],
"meta":{
"links":{
"next":"https://api.getbase.com/v3/tasks/stream?position=ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg=="
},
"position":"ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg==",
"top":false
}
}