For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomepageProduct HelpLog inTry for Free
Developers HomeAPI ReferenceMCP
Developers HomeAPI ReferenceMCP
  • Getting Started
    • Introduction
    • Authentication with API Keys
    • Authentication with OAuth
    • API Clients
    • Pagination
    • Specifying Fields
    • Filter Parameters
    • HTTP Response Codes
    • Rate Limits
    • Timezone Offsets
    • Rich Text Fields
    • Changelog
  • CRM Core
    • Leads
    • Contacts
    • Opportunities
    • Tasks
      • GETList or filter tasks
      • POSTCreate a task
      • PUTBulk-update tasks
      • GETFetch a task's details
      • PUTUpdate a task
      • DELDelete a task
    • Files
    • Custom Objects
    • Comments
  • Activities
    • Activities
    • Notes
    • Calls
    • Emails
    • Email Threads
    • WhatsApp Messages
    • Meetings
    • Custom Activities
    • Creations
    • Form Submissions
    • Lead Status Changes
    • Opportunity Status Changes
    • Lead Merges
    • Task Completions
  • Events & Webhooks
    • Webhooks
    • Events
  • Search & Reporting
    • Advanced Filtering
    • Smart Views
    • Reporting
  • Automation & Bulk Actions
    • Sequences (Workflows)
    • Bulk Actions
    • Exports
    • AI Field Enrichment
  • CRM Configuration
    • Custom Fields
    • Custom Activity Types
    • Custom Object Types
    • Pipelines
    • Opportunity Statuses
    • Lead Statuses
    • Integration Links
    • Forms
  • Communication Configuration
    • Email Templates
    • SMS Templates
    • Outcomes
    • Playbooks
    • Scheduling Links Guide
    • Scheduling Links
    • Connected Accounts
    • Send As
    • Unsubscribed Emails
    • Phone Numbers
    • Blocked Phone Numbers
    • Dialers
  • Users & Organizations
    • Users
    • Organizations
    • Memberships
    • Roles
    • Groups
Close

Product

OverviewCommunicationAutomationIntegrationsReportingSMSCallingSecurityForms

Pricing & Use Cases

PricingClose vs Other CRMsCustomer Stories

Resources

Sales BlogSales ResourcesSales GuidesWebinarsOn-Demand DemoSales Tools

Company

AboutCareersPartner with CloseBrand GuidelinesTermsPrivacyGDPRCCPA

Get Help

+1-833-GO-CLOSEHelp CenterDownload the Close AppProduct UpdatesSystem Status
LogoLogo
HomepageProduct HelpLog inTry for Free
CRM CoreTasks

List or filter tasks

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

Tasks

Next

Create a task

Built with

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
Use your API key as the username and leave the password empty.
OR
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