Tasks

The Tasks API provides a simple interface to manage tasks. The API allows you to create, delete and update your tasks. You can retrieve a single task, as well as list of all tasks.

A task can be either floating or related. Floating tasks are only associated with a user, whereas related tasks are associated with one of listed resources:

• Leads
• Contacts
• Deals

Parameters

Retrieve all tasks

GET /v2/tasks

Returns all tasks available to the user, according to the parameters provided.

If you ask for tasks without any parameter provided Sell API will return you both floating and related tasks. Although you can narrow the search set to either of them via query parameters.

Parameters

Allowed for

• Agents

Using cURL

curl -v -X GET https://api.getbase.com/v2/tasks?type=related&resource_type=leads&completed=true \-H "Accept: application/json" \-H "Authorization: Bearer $ACCESS_TOKEN"

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "items": [    {      "data": {        "id": 1,        "creator_id": 1,        "owner_id": 1,        "resource_type": "lead",        "resource_id": 1,        "completed": true,        "completed_at": "2014-09-29T16:32:56Z",        "due_date": "2014-09-28T16:32:56Z",        "overdue": false,        "remind_at": "2014-09-29T15:32:56Z",        "content": "Contact Tom",        "created_at": "2014-08-27T16:32:56Z",        "updated_at": "2014-08-27T17:32:56Z"      },      "meta": {        "type": "task"      }    }  ],  "meta": {    "type": "collection",    "count": 1,    "links": {      "self": "http://api.getbase.com/v2/tasks.json"    }  }}

---

Create a task

POST /v2/tasks

Creates a new task. You can create either a floating task or create a related task and associate it with one of the resource types below:

• Leads
• Contacts
• Deals

The remind_at date must be set earlier than the due_date attribute. Note that while you can specify different timezones in datetime fields during task creation, this functionality is not supported in the Search API. The Search API does not permit the use of different timezones in tasks.

Parameters

Allowed for

• Agents

Using cURL

curl -v -X POST https://api.getbase.com/v2/tasks \-H "Accept: application/json" \-H "Content-Type: application/json" \-H "Authorization: Bearer $ACCESS_TOKEN" \-d '{  "data": {    "resource_type": "lead",    "resource_id": 1,    "due_date": "2014-09-27T16:32:56Z",    "remind_at": "2014-09-26T15:32:56Z",    "content": "Contact Tom"  },  "meta": {    "type": "task"  }}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "data": {    "id": 1,    "creator_id": 1,    "owner_id": 1,    "resource_type": "lead",    "resource_id": 1,    "completed": true,    "completed_at": "2014-09-29T16:32:56Z",    "due_date": "2014-09-28T16:32:56Z",    "overdue": false,    "remind_at": "2014-09-29T15:32:56Z",    "content": "Contact Tom",    "created_at": "2014-08-27T16:32:56Z",    "updated_at": "2014-08-27T17:32:56Z"  },  "meta": {    "type": "task"  }}

---

Retrieve a single task

GET /v2/tasks/:id

Returns a single task available to the user according to the unique task ID provided. If the specified task does not exist, this query will return an error.

Parameters

Allowed for

• Agents

Using cURL

curl -v -X GET https://api.getbase.com/v2/tasks/1 \-H "Accept: application/json" \-H "Authorization: Bearer $ACCESS_TOKEN"

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "data": {    "id": 1,    "creator_id": 1,    "owner_id": 1,    "resource_type": "lead",    "resource_id": 1,    "completed": true,    "completed_at": "2014-09-29T16:32:56Z",    "due_date": "2014-09-28T16:32:56Z",    "overdue": false,    "remind_at": "2014-09-29T15:32:56Z",    "content": "Contact Tom",    "created_at": "2014-08-27T16:32:56Z",    "updated_at": "2014-08-27T17:32:56Z"  },  "meta": {    "type": "task"  }}

---

Update a task

PUT /v2/tasks/:id

Updates task information. If the specified task does not exist, this query will return an error.

Parameters

Allowed for

• Agents

Using cURL

curl -v -X PUT https://api.getbase.com/v2/tasks/1 \-H "Accept: application/json" \-H "Content-Type: application/json" \-H "Authorization: Bearer $ACCESS_TOKEN" \-d '{  "data": {    "completed": false,    "content": "Contact Tom and Rachel"  }}'

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "data": {    "id": 1,    "creator_id": 1,    "owner_id": 1,    "resource_type": "lead",    "resource_id": 1,    "completed": false,    "completed_at": null,    "due_date": "2014-09-28T16:32:56Z",    "overdue": false,    "remind_at": "2014-09-29T15:32:56Z",    "content": "Contact Tom and Rachel",    "created_at": "2014-08-27T16:32:56Z",    "updated_at": "2014-08-27T17:32:56Z"  },  "meta": {    "type": "task"  }}

---

Delete a task

DELETE /v2/tasks/:id

Delete an existing task. If the specified task does not exist, this query will return an error. This operation cannot be undone.

Parameters

Allowed for

• Agents

Using cURL

curl -v -X DELETE https://api.getbase.com/v2/tasks/1 \-H "Authorization: Bearer $ACCESS_TOKEN"

Example response

HTTP/1.1 204 No Content