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
    • Files
    • Custom Objects
    • Comments
  • Activities
    • Activities
      • GETList or filter all activity types
    • 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
ActivitiesActivities

List or filter all activity types

||View as Markdown|
GET
https://api.close.com/api/v1/activity/
GET
/api/v1/activity/
$curl https://api.close.com/api/v1/activity/ \
> -u "<CLOSE_API_KEY>:"
1{
2 "data": [
3 {
4 "_type": "Created",
5 "activity_at": "2013-02-20T05:44:35.636000+00:00",
6 "contact_id": null,
7 "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
8 "created_by_name": "Bruce Wayne",
9 "date_created": "2013-02-20T05:44:35.636000+00:00",
10 "date_updated": "2013-02-20T05:44:35.667000+00:00",
11 "id": "acti_ICUkwteuKAaJvhNqF1QBoVOWKQuSbFuOYoZxGeWQAeg",
12 "lead_id": "lead_pqXrF8figcDHN7HvaXmb4wTjpxnxpmqheEyjTYPfdi5",
13 "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
14 "source": "api",
15 "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
16 "updated_by_name": "Bruce Wayne",
17 "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
18 "user_name": "Bruce Wayne"
19 },
20 {
21 "_type": "Created",
22 "activity_at": "2013-02-20T05:44:31.940000+00:00",
23 "contact_id": null,
24 "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
25 "created_by_name": "Bruce Wayne",
26 "date_created": "2013-02-20T05:44:31.940000+00:00",
27 "date_updated": "2013-02-20T05:44:31.955000+00:00",
28 "id": "acti_k8u1xLU5G9L0YLkxLqAHEZFB84oB7fN9vqjCgljfcFN",
29 "lead_id": "lead_6SY1tPBB1EnQneopPGSLsAmXVkTRf4P0r6Y6ntdPowL",
30 "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
31 "source": "api",
32 "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
33 "updated_by_name": "Bruce Wayne",
34 "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
35 "user_name": "Bruce Wayne"
36 },
37 {
38 "_type": "Created",
39 "activity_at": "2013-02-20T05:30:24.854000+00:00",
40 "contact_id": null,
41 "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
42 "created_by_name": "Bruce Wayne",
43 "date_created": "2013-02-20T05:30:24.854000+00:00",
44 "date_updated": "2013-02-20T05:30:24.870000+00:00",
45 "id": "acti_0wDacWkNoKKVn7I8wCuEc1XbQ7lGQxCgZ9WNQn71P8j",
46 "lead_id": "lead_70jZ5hiVt5X31MZ3vJ0R0GJMqJEihkoF7TtSVFbN2ty",
47 "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
48 "source": "api",
49 "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
50 "updated_by_name": "Bruce Wayne",
51 "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
52 "user_name": "Bruce Wayne"
53 },
54 {
55 "_type": "Email",
56 "activity_at": "2013-02-08T05:03:15.000000+00:00",
57 "attachments": [],
58 "bcc": [],
59 "body_html": "Cool!<br>\n<br>\nThis is rad. &lt;3<br>\n<br><br>______________________________________________<br>Sent via <a href='http://close.com/?utm_source=signature&utm_medium=email&utm_campaign=signature'>Close</a> &ndash; sales communication made simple",
60 "body_text": "Cool!\n\nThis is rad. <3\n\n\n______________________________________________\nSent via http://close.com/ - sales communication made simple",
61 "body_text_quoted": [
62 {
63 "expand": true,
64 "text": "Cool!\n\nThis is rad. <3\n\n\n______________________________________________\nSent via http://close.com/ - sales communication made simple"
65 }
66 ],
67 "cc": [],
68 "contact_id": "cont_eXZwc2SVL4G3xSR85jnfPny2ykvoAQndSyi1Doa2YLO",
69 "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
70 "created_by_name": "Bruce Wayne",
71 "date_created": "2013-02-08T05:02:42.050000+00:00",
72 "date_updated": "2013-02-08T05:03:16.281000+00:00",
73 "direction": "outgoing",
74 "envelope": {
75 "bcc": [],
76 "cc": [],
77 "date": "Fri, 08 Feb 2013 05:03:15 +0000",
78 "from": [
79 {
80 "email": "phil@close.com",
81 "name": "Phil Freo"
82 }
83 ],
84 "in_reply_to": null,
85 "message_id": "<20130208050314.11553.33819@ec2-54-245-86-79.us-west-2.compute.amazonaws.com>",
86 "reply_to": [],
87 "sender": [
88 {
89 "email": "phil@close.com",
90 "name": "Phil Freo"
91 }
92 ],
93 "subject": "Testing testing!!!!",
94 "to": [
95 {
96 "email": "phil@close.com",
97 "name": ""
98 }
99 ]
100 },
101 "id": "acti_C4DFcBED1FwLSDqn853hjc979h7DIuH2vwABzGWhRAO",
102 "lead_id": "lead_KwD00BYbXCHiPWj68LxFkxaeWuULpZ7awzm6LqeFs0h",
103 "opens": [],
104 "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
105 "send_attempts": [],
106 "sender": "phil@close.com",
107 "status": "sent",
108 "subject": "Testing testing!!!!",
109 "template_id": null,
110 "to": [
111 "phil@close.com"
112 ],
113 "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
114 "updated_by_name": "Bruce Wayne",
115 "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
116 "user_name": "Bruce Wayne"
117 },
118 {
119 "_type": "Note",
120 "activity_at": "2013-02-01T01:05:04.070000+00:00",
121 "contact_id": null,
122 "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
123 "created_by_name": "Bruce Wayne",
124 "date_created": "2013-02-01T01:05:04.070000+00:00",
125 "date_updated": "2013-02-01T01:06:35.668000+00:00",
126 "id": "acti_XOyG7jURMfsLgKuYGqbQ4Qp7L5a16pQOcDfTgotqDak",
127 "lead_id": "lead_KwD00BYbXCHiPWj68LxFkxaeWuULpZ7awzm6LqeFs0h",
128 "note": "Welcome to Close! Get started by:\n\n1. Import your leads! Use our \"Bulk CSV Upload\" tool by clicking your name in the top right. Add leads manually by clicking \"New Lead\" in the lower left.\n\n2. Invite your co-workers!\n\n3. Setup two-way syncing of your emails by going to Settings -> Email Settings.",
129 "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
130 "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
131 "updated_by_name": "Bruce Wayne",
132 "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
133 "user_name": "Bruce Wayne"
134 },
135 {
136 "_type": "Email",
137 "activity_at": "2013-02-01T00:54:51.000000+00:00",
138 "attachments": [],
139 "bcc": [],
140 "body_html": "Hi! My name is Karan and I'm your Account Manager. I'm here to get your team set up and help with anything you may need as you evaluate our platform. Please don't hesitate to reach out to me with any questions!",
141 "body_text": "Hi! My name is Karan and I'm your Account Manager. I'm here to get your team set up and help with anything you may need as you evaluate our platform. Please don't hesitate to reach out to me with any questions!",
142 "body_text_quoted": [
143 {
144 "expand": true,
145 "text": "Hi! My name is Karan and I'm your Account Manager. I'm here to get your team set up and help with anything you may need as you evaluate our platform. Please don't hesitate to reach out to me with any questions!"
146 }
147 ],
148 "cc": [],
149 "contact_id": "cont_8NNOJnVwmHQEYuVOgJ4B4zU7g9RUxYH4JnPjza5Vr6t",
150 "created_by": null,
151 "date_created": "2013-02-01T00:54:51.274000+00:00",
152 "date_updated": "2013-02-01T00:56:04.184000+00:00",
153 "direction": "incoming",
154 "envelope": {
155 "bcc": [],
156 "cc": [],
157 "date": "Fri, 01 Feb 2013 00:54:51 +0000",
158 "from": [
159 {
160 "email": "karan@close.com",
161 "name": ""
162 }
163 ],
164 "in_reply_to": null,
165 "message_id": "<20130201005451.14369.20369@ec2-54-245-86-79.us-west-2.compute.amazonaws.com>",
166 "reply_to": [],
167 "sender": [
168 {
169 "email": "karan@close.com",
170 "name": ""
171 }
172 ],
173 "subject": "Welcome to Close!",
174 "to": [
175 {
176 "email": "phil+sample@close.com",
177 "name": ""
178 }
179 ]
180 },
181 "id": "acti_WuIVvTT9b3zLmOOWalxK0OrqtdkxEEdu4mNr1TPGb2o",
182 "lead_id": "lead_KwD00BYbXCHiPWj68LxFkxaeWuULpZ7awzm6LqeFs0h",
183 "opens": [],
184 "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
185 "send_attempts": [],
186 "sender": "karan@close.com",
187 "status": "inbox",
188 "subject": "Welcome to Close!",
189 "template_id": null,
190 "to": [
191 "phil+sample@close.com"
192 ],
193 "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
194 "updated_by_name": "Bruce Wayne",
195 "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
196 "user_name": "Bruce Wayne"
197 }
198 ],
199 "has_more": false
200}
To list only a specific activity type (e.g., only `Call` or `LeadStatusChange`), use the other resources listed separately. When querying activities for a single lead (using the `lead_id` parameter), you can ask for multiple activity types using `_type__in`. When listing [Custom Activities](https://developer.close.com/api/resources/activities/custom-activities), `_type` and `_type__in` can include Custom Activity Type ids (e.g. `actitype_1h5m6uHM9BZOpwVhyRJb4Y`) to filter by a specific custom activity type or `Custom` to list custom activities of any type. The following filtering parameters can only be used for listing activities on a single lead (using the `lead_id` parameter): `user_id`, `user_id__in`, `contact_id`, `contact_id__in`, `_type`, `_type__in`. All activities have two sortable datetime fields: `date_created` and `activity_at`. `date_created` denotes when an activity was created or synced into Close and `activity_at` denotes when that activity actually occurred. For example, on outgoing Email activities, `date_created` is equal to when the email was first created in Close, and `activity_at` is equal to when the email was actually sent. For Meeting activities, `activity_at` is equal to the scheduled time of the meeting. On custom activities, users are able to update the `activity_at` field at any time. Sorting by `-activity_at` can only be used when listing activities on a single lead using the `lead_id` parameter. In addition, you can only use the date-based filters of the field you're currently sorting on. This means that if you want to use `activity_at__lt` and `activity_at__gt` as filters, you need to include `_order_by=-activity_at` in your request. `thread_emails` parameter: - (Default) when this parameter is not present, `Email` objects will be returned for each email message. - A value of `true` will return `EmailThread` objects representing email conversations. Stripped-down version of `Email` objects will also be returned. - A value of `only` will return `EmailThread` objects representing email conversations. `Email` objects will not be returned.
Was this page helpful?
Previous

Activities

Next

Notes

Built with

To list only a specific activity type (e.g., only Call or LeadStatusChange), use the other resources listed separately. When querying activities for a single lead (using the lead_id parameter), you can ask for multiple activity types using _type__in.

When listing Custom Activities, _type and _type__in can include Custom Activity Type ids (e.g. actitype_1h5m6uHM9BZOpwVhyRJb4Y) to filter by a specific custom activity type or Custom to list custom activities of any type.

The following filtering parameters can only be used for listing activities on a single lead (using the lead_id parameter): user_id, user_id__in, contact_id, contact_id__in, _type, _type__in.

All activities have two sortable datetime fields: date_created and activity_at. date_created denotes when an activity was created or synced into Close and activity_at denotes when that activity actually occurred. For example, on outgoing Email activities, date_created is equal to when the email was first created in Close, and activity_at is equal to when the email was actually sent. For Meeting activities, activity_at is equal to the scheduled time of the meeting. On custom activities, users are able to update the activity_at field at any time.

Sorting by -activity_at can only be used when listing activities on a single lead using the lead_id parameter. In addition, you can only use the date-based filters of the field you’re currently sorting on. This means that if you want to use activity_at__lt and activity_at__gt as filters, you need to include _order_by=-activity_at in your request.

thread_emails parameter:

  • (Default) when this parameter is not present, Email objects will be returned for each email message.
  • A value of true will return EmailThread objects representing email conversations. Stripped-down version of Email objects will also be returned.
  • A value of only will return EmailThread objects representing email conversations. Email objects will not be returned.

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.
id__inlist of strings or nullOptional

Filter by activity IDs (comma-separated)

lead_idlist of strings or nullOptional

Filter by lead IDs (comma-separated)

contact_idlist of strings or nullOptional

Filter by contact IDs (comma-separated)

user_idlist of strings or nullOptional

Filter by user IDs (comma-separated)

organization_idstring or nullOptional
_typelist of strings or nullOptional

Filter by activity type, e.g. Call (comma-separated)

date_created__gtedatetime or dateOptional
date_created__ltedatetime or dateOptional
date_created__gtdatetime or dateOptional
date_created__ltdatetime or dateOptional
activity_at__gtedatetime or dateOptional
activity_at__ltedatetime or dateOptional
activity_at__gtdatetime or dateOptional
activity_at__ltdatetime or dateOptional
lead_id__instringOptional
user_id__instringOptional
contact_id__instringOptional
_type__instringOptional
_fieldsstringOptional

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

_order_bystringOptional

Response

Successful response

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error