Get a single Email activity

GET

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

GET

/api/v1/activity/email/:id/

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

1 {
2   "_type": "Email",
3   "activity_at": "2013-02-01T00:54:51.274000+00:00",
4   "bcc": [],
5   "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!",
6   "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!",
7   "bulk_email_action_id": null,
8   "cc": [],
9   "contact_id": "cont_8NNOJnVwmHQEYuVOgJ4B4zU7g9RUxYH4JnPjza5Vr6t",
10   "created_by": null,
11   "date_created": "2013-02-01T00:54:51.274000+00:00",
12   "date_scheduled": null,
13   "date_sent": "2013-02-01T00:54:51.274000+00:00",
14   "date_updated": "2013-02-01T00:56:04.184000+00:00",
15   "direction": "incoming",
16   "followup_sequence_add_cc_bcc": false,
17   "followup_sequence_delay": null,
18   "has_reply": false,
19   "id": "acti_WuIVvTT9b3zLmOOWalxK0OrqtdkxEEdu4mNr1TPGb2o",
20   "in_reply_to_id": null,
21   "lead_id": "lead_KwD00BYbXCHiPWj68LxFkxaeWuULpZ7awzm6LqeFs0h",
22   "message_ids": [],
23   "need_smtp_credentials": false,
24   "opens_summary": null,
25   "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
26   "references": [],
27   "send_as_id": null,
28   "sender": "karan@close.com",
29   "status": "inbox",
30   "subject": "Welcome to Close!",
31   "template_id": null,
32   "thread_id": "acti_WuIVvTT9b3zLmOOWalxK0OrqtdkxEEdu4mNr1TPGb2o",
33   "to": [
34     "phil+sample@close.com"
35   ],
36   "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
37   "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
38   "users": [],
39   "attachments": [],
40   "envelope": {
41     "bcc": [],
42     "cc": [],
43     "date": "Fri, 01 Feb 2013 00:54:51 +0000",
44     "from": [
45       {
46         "email": "karan@close.com",
47         "name": ""
48       }
49     ],
50     "in_reply_to": null,
51     "message_id": "<20130201005451.14369.20369@ec2-54-245-86-79.us-west-2.compute.amazonaws.com>",
52     "reply_to": [],
53     "sender": [
54       {
55         "email": "karan@close.com",
56         "name": ""
57       }
58     ],
59     "subject": "Welcome to Close!",
60     "to": [
61       {
62         "email": "phil+sample@close.com",
63         "name": ""
64       }
65     ]
66   },
67   "opens": [],
68   "send_attempts": [],
69   "sequence_id": "seq_1BTljGuCooX0nbFoPihl07",
70   "sequence_name": "My Sequence",
71   "sequence_subscription_id": "sub_wRlAku35U53xEV7PcNY3Qo",
72   "updated_by_name": "Bruce Wayne",
73   "user_name": "Bruce Wayne",
74   "body_text_quoted": [
75     {
76       "expand": true,
77       "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!"
78     }
79   ]
80 }

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.

Path parameters

idstringRequired

Query parameters

_fieldsstringOptional

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

Response

Successful response

_typestring

activity_atdatetime or null

bcclist of strings

body_htmlstring or null

body_textstring or null

bulk_email_action_idstring or null

cclist of strings

contact_idstring or null

created_bystring or null

date_createddatetime

date_scheduleddatetime or null

date_sentdatetime or null

date_updateddatetime

directionenum or null

Direction of communication. Outgoing means the communication flowing from the user to the lead/contact. Inbound means the opposite.

followup_sequence_add_cc_bccboolean

followup_sequence_delayinteger or null

has_replyboolean

idstring

in_reply_to_idstring or null

lead_idstring or null

message_idslist of strings

need_smtp_credentialsboolean

opens_summarystring or null

organization_idstring

referenceslist of strings

send_as_idstring or null

senderstring or null

statusenum

Status of a message, such as Email or SMS.

subjectstring or null

template_idstring or null

thread_idstring or null

tolist of strings

updated_bystring or null

user_idstring or null

userslist of strings

agent_action_reasonstring or nullOptional

agent_config_idstring or nullOptional

attachmentslist of objects or nullOptional

body_previewstring or nullOptional

created_by_namestring or nullOptional

email_account_idstring or nullOptional

envelopemap from strings to any or nullOptional

followup_sequence_idstring or nullOptional

openslist of objects or nullOptional

send_attemptslist of maps from strings to strings or nullOptional

sequence_idstring or nullOptional

sequence_namestring or nullOptional

sequence_subscription_idstring or nullOptional

template_namestring or nullOptional

updated_by_namestring or nullOptional

user_namestring or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error