List or filter all Email activities

GET

https://api.close.com/api/v1/activity/email/

GET

/api/v1/activity/email/

$ curl https://api.close.com/api/v1/activity/email/ \
>      -u "<CLOSE_API_KEY>:"

1 {
2   "data": [
3     {
4       "_type": "Email",
5       "activity_at": "2013-02-08T05:02:42.050000+00:00",
6       "bcc": [],
7       "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",
8       "body_text": "Cool!\n\nThis is rad. <3\n\n\n______________________________________________\nSent via http://close.com/ - sales communication made simple",
9       "bulk_email_action_id": null,
10       "cc": [],
11       "contact_id": "cont_eXZwc2SVL4G3xSR85jnfPny2ykvoAQndSyi1Doa2YLO",
12       "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
13       "date_created": "2013-02-08T05:02:42.050000+00:00",
14       "date_scheduled": null,
15       "date_sent": "2013-02-08T05:02:42.050000+00:00",
16       "date_updated": "2013-02-08T05:03:16.281000+00:00",
17       "direction": "outgoing",
18       "followup_sequence_add_cc_bcc": false,
19       "followup_sequence_delay": null,
20       "has_reply": false,
21       "id": "acti_C4DFcBED1FwLSDqn853hjc979h7DIuH2vwABzGWhRAO",
22       "in_reply_to_id": null,
23       "lead_id": "lead_KwD00BYbXCHiPWj68LxFkxaeWuULpZ7awzm6LqeFs0h",
24       "message_ids": [
25         "<20130208050314.11553.33819@ec2-54-245-86-79.us-west-2.compute.amazonaws.com>"
26       ],
27       "need_smtp_credentials": false,
28       "opens_summary": null,
29       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
30       "references": [],
31       "send_as_id": null,
32       "sender": "phil@close.com",
33       "status": "sent",
34       "subject": "Testing testing!!!!",
35       "template_id": null,
36       "thread_id": "acti_C4DFcBED1FwLSDqn853hjc979h7DIuH2vwABzGWhRAO",
37       "to": [
38         "phil@close.com"
39       ],
40       "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
41       "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
42       "users": [],
43       "attachments": [
44         {
45           "content_type": "image/png",
46           "filename": "screenshot.png",
47           "size": 1108447,
48           "url": "https://app.close.com/go/file/persisted/orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH/activity.email/acti_C4DFcBED1FwLSDqn853hjc979h7DIuH2vwABzGWhRAO/3iPCenL9lciJrKnjFucsJ8/screenshot.png"
49         }
50       ],
51       "created_by_name": "Bruce Wayne",
52       "envelope": {
53         "bcc": [],
54         "cc": [],
55         "date": "Fri, 08 Feb 2013 05:03:15 +0000",
56         "from": [
57           {
58             "email": "phil@close.com",
59             "name": "Phil Freo"
60           }
61         ],
62         "in_reply_to": null,
63         "message_id": "<20130208050314.11553.33819@ec2-54-245-86-79.us-west-2.compute.amazonaws.com>",
64         "reply_to": [],
65         "sender": [
66           {
67             "email": "phil@close.com",
68             "name": "Phil Freo"
69           }
70         ],
71         "subject": "Testing testing!!!!",
72         "to": [
73           {
74             "email": "phil@close.com",
75             "name": ""
76           }
77         ]
78       },
79       "opens": [],
80       "send_attempts": [],
81       "sequence_id": "seq_1BTljGuCooX0nbFoPihl07",
82       "sequence_name": "My Sequence",
83       "sequence_subscription_id": "sub_wRlAku35U53xEV7PcNY3Qo",
84       "updated_by_name": "Bruce Wayne",
85       "user_name": "John Wayne",
86       "body_text_quoted": [
87         {
88           "expand": true,
89           "text": "Cool!\n\nThis is rad. <3\n\n\n______________________________________________\nSent via http://close.com/ - sales communication made simple"
90         }
91       ]
92     },
93     {
94       "_type": "Email",
95       "activity_at": "2013-02-01T00:54:51.274000+00:00",
96       "bcc": [],
97       "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!",
98       "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!",
99       "bulk_email_action_id": null,
100       "cc": [],
101       "contact_id": "cont_8NNOJnVwmHQEYuVOgJ4B4zU7g9RUxYH4JnPjza5Vr6t",
102       "created_by": null,
103       "date_created": "2013-02-01T00:54:51.274000+00:00",
104       "date_scheduled": null,
105       "date_sent": "2013-02-01T00:54:51.274000+00:00",
106       "date_updated": "2013-02-01T00:56:04.184000+00:00",
107       "direction": "incoming",
108       "followup_sequence_add_cc_bcc": false,
109       "followup_sequence_delay": null,
110       "has_reply": false,
111       "id": "acti_WuIVvTT9b3zLmOOWalxK0OrqtdkxEEdu4mNr1TPGb2o",
112       "in_reply_to_id": null,
113       "lead_id": "lead_KwD00BYbXCHiPWj68LxFkxaeWuULpZ7awzm6LqeFs0h",
114       "message_ids": [
115         "<20130201005451.14369.20369@ec2-54-245-86-79.us-west-2.compute.amazonaws.com>"
116       ],
117       "need_smtp_credentials": false,
118       "opens_summary": null,
119       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
120       "references": [],
121       "send_as_id": null,
122       "sender": "karan@close.com",
123       "status": "inbox",
124       "subject": "Welcome to Close!",
125       "template_id": null,
126       "thread_id": "acti_WuIVvTT9b3zLmOOWalxK0OrqtdkxEEdu4mNr1TPGb2o",
127       "to": [
128         "phil+sample@close.com"
129       ],
130       "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
131       "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
132       "users": [],
133       "attachments": [],
134       "envelope": {
135         "bcc": [],
136         "cc": [],
137         "date": "Fri, 01 Feb 2013 00:54:51 +0000",
138         "from": [
139           {
140             "email": "karan@close.com",
141             "name": ""
142           }
143         ],
144         "in_reply_to": null,
145         "message_id": "<20130201005451.14369.20369@ec2-54-245-86-79.us-west-2.compute.amazonaws.com>",
146         "reply_to": [],
147         "sender": [
148           {
149             "email": "karan@close.com",
150             "name": ""
151           }
152         ],
153         "subject": "Welcome to Close!",
154         "to": [
155           {
156             "email": "phil+sample@close.com",
157             "name": ""
158           }
159         ]
160       },
161       "opens": [],
162       "send_attempts": [],
163       "updated_by_name": "Bruce Wayne",
164       "body_text_quoted": [
165         {
166           "expand": true,
167           "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!"
168         }
169       ]
170     }
171   ],
172   "has_more": false
173 }

You'll get one object per email message.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

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

Response

Successful response

datalist of objects

has_moreboolean

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error