List all tasks

get https://{youraccountname}.api-us1.com/api/3/dealTasks

Retrieve a list of existing tasks

{
  "dealTasks": [{
    "id":"1",
    "duedate":"2017-02-25T12:00:00-06:00",
    "edate":"2017-02-25T12:15:00-06:00",
    "status":0,
    "title":null,
    "note":"Testing Task",
    "relid":"7",
    "reltype":"Subscriber",
    "dealTasktype":"1",
    "cdate":"2017-02-24T13:21:56-06:00",
    "udate":"2017-02-24T13:21:56-06:00",
    "automation":null,
    "doneAutomation":null,
    "user":"1",
    "assignee":"2",
    "owner":{
      "type":"contact",
      "id":"7"
    },
    "outcomeId": null,
		"outcomeInfo": null,
    "links": {
      "activities":"/1/activities",
      "automation":"/1/automation",
      "dealTasktype":"/1/dealTasktype",
      "doneAutomation":"/1/doneAutomation",
      "notes":"/1/notes",
      "owner":"/1/owner",
      "taskNotifications":"/1/taskNotifications",
      "user":"/3/dealTasks/1/user",
      "assignee":"/1/assignee"
    }
  },
  {
    "id":"2",
    "duedate":"2017-02-25T12:00:00-06:00",
    "edate":"2017-02-25T12:15:00-06:00",
    "status":0,
    "title":null,
    "note":"Testing Task 2",
    "relid":"8",
    "reltype":"Deal",
    "dealTasktype":"1",
    "cdate":"2017-02-24T13:21:56-06:00",
    "udate":"2017-02-24T13:21:56-06:00",
    "automation":null,
    "doneAutomation":null,
    "user":"1",
    "assignee":"2",
    "owner":{
      "type":"deal",
      "id":"5"
    },
    "outcomeId": 91,
		"outcomeInfo": "More details about the outcome",
    "links": {
      "activities":"/2/activities",
      "automation":"/2/automation",
      "dealTasktype":"/2/dealTasktype",
      "doneAutomation":"/2/doneAutomation",
      "notes":"/2/notes",
      "owner":"/2/owner",
      "taskNotifications":"/2/taskNotifications",
      "user":"/2/user",
      "assignee":"/1/assignee"
    }
  }],
  "meta":{
    "total":"2"
  }
}

Query Params

filters[title]

string

The title to be assigned to the task

filters[reltype]

string

The name of the relating object (see relationships table)

filters[relid]

int32

The id of the relational object for this task

filters[status]

int32

Task status means complete or incomplete. 1 is complete and 0 is incomplete.

filters[note]

string

The content describing the task

filters[duedate]

date

Due date of the task

filters[d_tasktypeid]

int32

The type of the task based on the available Task Types in the account

filters[userid]

int32

User ID this task belongs to

filters[due_after]

string

Filter deal tasks that are due after a specific date

Fitlers[due_before]

string

Filter deal tasks that are due before a specific date

filters[duedate_range]

string

Filter deal tasks that are due between specific date range (YYYY-MM-DD+YYYY-MM-DD format) or get categorized tasks (upcoming, scheduled, overdue values)

filters[assignee_userid]

int32

The id of the user a task is assigned to

filters[outcome_id]

int32

The id of a task outcome that the task belongs to.

Responses

Language

Credentials

Header

URL


xxxxxxxxxx
11
1
using RestSharp;
2
3
4
var options = new RestClientOptions("https://youraccountname.api-us1.com/api/3/dealTasks");
5
var client = new RestClient(options);
6
var request = new RestRequest("");
7
request.AddHeader("accept", "application/json");
8
var response = await client.GetAsync(request);
9
10
Console.WriteLine("{0}", response.Content);
11

Choose an example:

application/json

201201

400400