List or filter tasks

GET

https://api.close.com/api/v1/task/

GET

/api/v1/task/

1 curl https://api.close.com/api/v1/task/ \
2      -u "<CLOSE_API_KEY>:"

1 {
2   "data": [
3     {
4       "_type": "lead",
5       "assigned_to": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
6       "assigned_to_name": "John Doe",
7       "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
8       "created_by_name": "John Doe",
9       "date": "2015-02-08T00:00:00+00:00",
10       "date_created": "2015-02-08T20:30:54.314000+00:00",
11       "date_updated": "2015-02-26T19:11:36.128000+00:00",
12       "id": "task_aRUZXCm9lMb2LwipTPhfFoFbCsUnaoQh1ncQ7WLnjlI",
13       "is_complete": false,
14       "is_dateless": false,
15       "lead_id": "lead_5LmpOyrMQdJSUlbNGBSGfK5XzcioIm7aC94PSQamQJc",
16       "lead_name": "Close",
17       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
18       "text": "Connect with Account Manager",
19       "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
20       "updated_by_name": "John Doe",
21       "view": "inbox"
22     },
23     {
24       "_type": "missed_call",
25       "assigned_to": "user_alksdjfWZ9sg3FHYQcUwV7tbwZRpe3sA215Ftv8OvbU",
26       "assigned_to_name": "Stefan Wojcik",
27       "contact_id": "cont_nWEklsdiC4z8u0b9QcNV92pWZODOyS5eUIYkvID0poZ",
28       "contact_name": "",
29       "date": "2015-05-27T18:33:52.937000+00:00",
30       "date_created": "2015-05-27T18:33:52.937000+00:00",
31       "date_updated": "2015-05-27T18:35:28.120000+00:00",
32       "id": "noti_034u5OZh3J759uE9kokI5r0xzhKE1tsfwcIwW5kXtWy",
33       "is_complete": false,
34       "lead_id": "lead_098324SXepf2mAk33WOIOvJYlis9dvRKJJe0wt1AwFE",
35       "lead_name": "Lead Name",
36       "local_phone": "+19193332031",
37       "object_id": "acti_7ALcldIJ9faMty47UM8xqAr0AMLeGcCUTmK32FuURJO",
38       "object_type": "call",
39       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
40       "phone": "+16503334444",
41       "phone_formatted": "+1 650-333-4444",
42       "phone_number_description": "California",
43       "view": "inbox"
44     },
45     {
46       "_type": "voicemail",
47       "assigned_to": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
48       "assigned_to_name": "John Doe",
49       "date": "2014-01-29T21:18:37.535000+00:00",
50       "date_created": "2015-02-26T19:24:39.847000+00:00",
51       "date_updated": "2015-02-26T19:24:39.849000+00:00",
52       "id": "noti_7WlHZCMgokvfv3H4SfymZLvG29QTifbGK0zMbEbPNgO",
53       "is_complete": false,
54       "local_phone": "+16319099219",
55       "object_id": "acti_ZnroXFGejb5JjYnluywM9wjKAGPwU3IpidvQZtW7WRp",
56       "object_type": "call",
57       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
58       "phone": "+16314238017",
59       "view": "inbox",
60       "voicemail_duration": 21,
61       "voicemail_url": "https://s3.amazonaws.com/plivocloud/aaa-bbb-ccc.mp3"
62     },
63     {
64       "_type": "incoming_email",
65       "assigned_to": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
66       "assigned_to_name": "John Doe",
67       "body_preview": "Hi, does your company provide metrics for 12/2014?",
68       "contact_id": "cont_73beDdTK5JOR7TMd5ervPFCwJ2jbXCPLtBfVY0yeg9X",
69       "contact_name": "",
70       "date": "2015-01-09T19:50:49+00:00",
71       "date_created": "2015-01-09T19:50:49+00:00",
72       "date_updated": "2015-02-26T19:24:38.643000+00:00",
73       "emails": [
74         "acti_LfXPSR1K9IMFZwEq0yjtmrhjI9tSBQ4u4lb2lF87dzs"
75       ],
76       "id": "noti_xN0O5Owvrxn6k8BclFme7L46k3eUaPlGMN6Y5o3mkyS",
77       "is_complete": false,
78       "lead_id": "lead_E271nhg2okT6QJ7btzKmZwmZOhWSXeOG21PCJshsP3N",
79       "lead_name": "Test Company",
80       "object_id": "acti_jV7yfal4zwkKNTv66rGrHFd1uFUqhyNHc1m812xzcCF",
81       "object_type": "emailthread",
82       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
83       "subject": "December 2014 Metrics",
84       "view": "inbox"
85     },
86     {
87       "_type": "email_followup",
88       "assigned_to": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
89       "assigned_to_name": "John Doe",
90       "body_preview": "Please respond if you're interested",
91       "contact_id": "cont_73beDdTK5JOR7TMd5ervPFCwJ2jbXCPLtBfVY0yeg9X",
92       "contact_name": "",
93       "date": "2015-01-09T19:50:49+00:00",
94       "date_created": "2015-01-09T19:50:49+00:00",
95       "date_updated": "2015-02-26T19:24:38.643000+00:00",
96       "email_id": "acti_nwretk1K9IMFZwEq0yjtmrhjI9tSBQ4u4lb2lbmnrqt",
97       "id": "noti_akhsweqrrxn6k8BclFme7L46k3eUaPlGMN6Y5o3mkyS",
98       "is_complete": false,
99       "lead_id": "lead_E271nhg2okT6QJ7btzKmZwmZOhWSXeOG21PCJshsP3N",
100       "lead_name": "Test Company",
101       "object_id": "acti_nmsdgwqetlkKNTv66rGrHFd1uFUqhyNHc1m812xzbsq",
102       "object_type": "emailthread",
103       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
104       "subject": "I have an offer for you",
105       "view": "inbox"
106     },
107     {
108       "_type": "answered_detached_call",
109       "assigned_to": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
110       "assigned_to_name": "John Doe",
111       "date": "2015-01-09T19:49:49+00:00",
112       "date_created": "2015-01-09T19:50:49+00:00",
113       "date_updated": "2015-02-26T19:24:38.643000+00:00",
114       "id": "noti_xc42fe5JD4y2GkcVhXQcbrrQKXjG6XDk5kuzBC1yRk0",
115       "is_complete": false,
116       "object_id": "acti_gtb5mn2YAO4up2Tv7XMjV5FLMif6JVebYxDOrqvnzas",
117       "object_type": "call",
118       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
119       "phone": "+16504298174",
120       "phone_formatted": "+1 650-429-8174",
121       "phone_number_description": "California",
122       "recording_url": "https://s3.amazonaws.com/plivocloud/aaa-bbb-ccc.mp3",
123       "view": "inbox"
124     },
125     {
126       "_type": "opportunity_due",
127       "assigned_to": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
128       "assigned_to_name": "Stefan Wojcik",
129       "contact_id": "cont_elkeZ5eRDRgoPfVvqTtnN8L0Rdj8fyNlI043oqPxQ6Z",
130       "contact_name": "John Doe",
131       "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
132       "created_by_name": "Stefan Wojcik",
133       "date": "2015-05-28T00:00:00+00:00",
134       "date_created": "2015-05-27T22:27:43.617000+00:00",
135       "date_updated": "2015-05-27T22:59:26.435000+00:00",
136       "id": "noti_7VfBZIqaXYO3tgdflHcY14kDu2mu9qeF32OT6PdOSqH",
137       "is_complete": false,
138       "lead_id": "lead_0yXstlx26nU5o3341BwO9oUbqHxwcvny8sYeWQo83gU",
139       "lead_name": "Test Inc.",
140       "object_id": "oppo_FOvMVC4D4OHvHyXjtoBytvS8QIKvqOjknPzzSyNei7e",
141       "object_type": "opportunity",
142       "opportunity_note": "tqm cvr",
143       "opportunity_value": 130000,
144       "opportunity_value_currency": "USD",
145       "opportunity_value_formatted": "$1,300",
146       "opportunity_value_period": "one_time",
147       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
148       "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
149       "updated_by_name": "Stefan Wojcik",
150       "view": "inbox"
151     },
152     {
153       "_type": "incoming_sms",
154       "assigned_to": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
155       "assigned_to_name": "Stefan Wojcik",
156       "attachments": [
157         {
158           "content_type": "image/png",
159           "filename": "media_1.png",
160           "media_id": "media_1GnAWzBfs0SOjTDcUnyyP9",
161           "size": 15148,
162           "thumbnail_url": "https://app.close.com/go/sms/acti_y10nW8kPdfmMPLy2Ufce9KymKPDuTRGKTqjpSxl6jMe/media/media_7Ga8l93XLVvqNsgjPbBuUI/thumbnail/",
163           "url": "https://app.close.com/go/sms/acti_y10nW8kPdfmMPLy2Ufce9KymKPDuTRGKTqjpSxl6jMe/media/media_7Ga8l93XLVvqNsgjPbBuUI/"
164         }
165       ],
166       "contact_id": "cont_TdzWUxuQbVMUiZbaF5ki5OFRdbGFXSD9kyw5CTPksIT",
167       "contact_name": "Steve Ballmer",
168       "date": "2016-09-21",
169       "date_created": "2016-09-21T19:00:05.835000+00:00",
170       "date_updated": "2016-09-21T19:00:05.835000+00:00",
171       "id": "noti_8cT0GaRs0Ol2d97MvlresffPHEpTAE5qi6EE6y5RrKw",
172       "is_complete": false,
173       "lead_id": "lead_iuSXNk1x4KrPggPVwQS7ynmp8pGRIDieRYiCnuo4yFb",
174       "lead_name": "New Lead",
175       "local_phone": "+16503334444",
176       "object_id": "acti_y10nW8kPdfmMPLy2Ufce9KymKPDuTRGKTqjpSxl6jMe",
177       "object_type": "sms",
178       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
179       "remote_phone": "+18189347000",
180       "remote_phone_description": "California",
181       "remote_phone_formatted": "+1 818-934-7000",
182       "text": "Developers developers developers developers!!!",
183       "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
184       "updated_by_name": "Stefan Wojcik",
185       "view": "inbox"
186     }
187   ],
188   "has_more": false
189 }

The view parameter can be used to conveniently access the different task views. It accepts one of the following values:

inbox: Shows incomplete tasks up to the end of the user’s day only (taking the time zone into account).
future: Shows incomplete tasks starting from the user’s tomorrow only (taking the time zone into account).
archive: Shows complete tasks only.

Note that a view value of inbox or future will override any date__lt or date__gte parameters included in the same request.

The _order_by field allows ordering by date or date_created (descending order by prepending a minus, e.g. _order_by=-date).

The `view` parameter can be used to conveniently access the different task views. It accepts one of the following values: * `inbox`: Shows incomplete tasks up to the end of the user's day only (taking the time zone into account). * `future`: Shows incomplete tasks starting from the user's tomorrow only (taking the time zone into account). * `archive`: Shows complete tasks only. Note that a `view` value of `inbox` or `future` will override any `date__lt` or `date__gte` parameters included in the same request. The `_order_by` field allows ordering by `date` or `date_created` (descending order by prepending a minus, e.g. `_order_by=-date`).

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

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

Query parameters

_limitintegerOptionalDefaults to 100

Number of results to return.

_skipintegerOptionalDefaults to 0

Number of results to skip before returning, for pagination.

assigned_tostring or nullOptional

formatstring or nullOptional

idstring or nullOptional

id__instring or nullOptional

is_completestring or nullOptional

lead_idstring or nullOptional

_order_bystring or nullOptional

organization_idstring or nullOptional

_typestring or nullOptional

_type__instring or nullOptional

viewstring or nullOptional

datestring or nullOptional

date__ltstring or nullOptional

date__ltestring or nullOptional

date__gtstring or nullOptional

date__gtestring or nullOptional

due_datestring or nullOptional

due_date__ltstring or nullOptional

due_date__ltestring or nullOptional

due_date__gtstring or nullOptional

due_date__gtestring or nullOptional

date_created__ltstring or nullOptional

date_created__ltestring or nullOptional

date_created__gtstring or nullOptional

date_created__gtestring or nullOptional

date_updated__ltstring or nullOptional

date_updated__ltestring or nullOptional

date_updated__gtstring or nullOptional

date_updated__gtestring or nullOptional

_fieldsstringOptional

Comma-separated list of fields to include in the response.

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error