Operations (sample payloads)

Main operations
Copy

Archive contact
Copy

Archives a single contact.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "contact_id": "5f1a2b3c4d5e6f7g8h9i0j"
4}

Sample Output

1{
2    "id": "5f1a2b3c4d5e6f7g8h9i0j",
3    "object": "contact",
4    "archived": true
5}

Assign conversation
Copy

Assigns a conversation to an admin or team. It also can be automatically assigned following assignment rules.

Sample Input

1{
2    "access_token": "dG9rZW4tMTIzNDU2Nzg5MA==",
3    "conversation_id": "123456789",
4    "assignment_rule": {
5        "type": "admin",
6        "admin_id": "987654321",
7        "assignee_id": "456789123",
8        "body": "Please handle this customer inquiry about our new product features."
9    }
10}

Sample Output

1{
2    "type": "conversation",
3    "id": "123456789",
4    "created_at": 1623456789,
5    "updated_at": 1623456890,
6    "waiting_since": 1623456789,
7    "snoozed_until": null,
8    "source": {
9        "type": "conversation",
10        "id": "123456789",
11        "delivered_as": "customer_initiated",
12        "subject": "Product Features Inquiry",
13        "body": "Hello, I have some questions about your new product features. Can you help?",
14        "author": {
15            "type": "user",
16            "id": "user_123",
17            "name": "John Doe",
18            "email": "john.doe@example.com"
19        },
20        "attachments": [],
21        "url": "https://app.intercom.com/a/apps/abc123/conversations/123456789"
22    },
23    "contacts": {
24        "type": "contact.list",
25        "contacts": [
26            {
27                "type": "user",
28                "id": "user_123"
29            }
30        ]
31    },
32    "first_contact_reply": {
33        "created_at": 1623456789,
34        "type": "conversation",
35        "url": "https://app.intercom.com/a/apps/abc123/conversations/123456789"
36    },
37    "open": true,
38    "state": "open",
39    "read": true,
40    "tags": {
41        "type": "tag.list",
42        "tags": []
43    },
44    "priority": "not_priority",
45    "sla_applied": null,
46    "statistics": {
47        "type": "conversation_statistics",
48        "time_to_assignment": 101,
49        "time_to_admin_reply": null,
50        "time_to_first_close": null,
51        "time_to_last_close": null,
52        "median_time_to_reply": null,
53        "first_contact_reply_at": 1623456789,
54        "first_assignment_at": 1623456890,
55        "first_admin_reply_at": null,
56        "first_close_at": null,
57        "last_assignment_at": 1623456890,
58        "last_assignment_admin_reply_at": null,
59        "last_contact_reply_at": 1623456789,
60        "last_admin_reply_at": null,
61        "last_close_at": null,
62        "last_closed_by_id": null,
63        "count_reopens": 0,
64        "count_assignments": 1,
65        "count_conversation_parts": 1
66    },
67    "conversation_rating": null,
68    "teammates": {
69        "type": "admin.list",
70        "admins": [
71            {
72                "type": "admin",
73                "id": "456789123"
74            }
75        ]
76    },
77    "conversation_parts": {
78        "type": "conversation_part.list",
79        "conversation_parts": [
80            {
81                "type": "conversation_part",
82                "id": "part_123",
83                "part_type": "assignment",
84                "body": "Please handle this customer inquiry about our new product features.",
85                "created_at": 1623456890,
86                "updated_at": 1623456890,
87                "notified_at": 1623456890,
88                "assigned_to": {
89                    "type": "admin",
90                    "id": "456789123"
91                },
92                "author": {
93                    "id": "987654321",
94                    "type": "admin",
95                    "name": "Admin User",
96                    "email": "admin@example.com"
97                },
98                "attachments": [],
99                "external_id": null
100            }
101        ],
102        "total_count": 1
103    },
104    "assignee": {
105        "type": "admin",
106        "id": "456789123"
107    }
108}

Attach contact to company
Copy

Attaches a single contact to a company.

Sample Input

1{
2    "access_token": "dG9rZW4=.eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
3    "contact_id": "5f1a2b3c4d5e6f7g8h9i0j",
4    "company_id": "1a2b3c4d5e6f7g8h9i0j1k"
5}

Sample Output

1{
2    "type": "company",
3    "company_id": "1a2b3c4d5e6f7g8h9i0j1k",
4    "id": "1a2b3c4d5e6f7g8h9i0j1k",
5    "app_id": "abc123def456",
6    "name": "Acme Corporation",
7    "remote_created_at": 1609459200,
8    "created_at": 1609459200,
9    "updated_at": 1625097600,
10    "monthly_spend": 5000,
11    "session_count": 150,
12    "user_count": 50,
13    "size": 200,
14    "website": "https://www.acmecorp.com",
15    "industry": "Technology",
16    "tags": {
17        "type": "list",
18        "tags": [
19            {
20                "type": "tag",
21                "name": "Enterprise",
22                "id": "tag123"
23            },
24            {
25                "type": "tag",
26                "name": "High Value",
27                "id": "tag456"
28            }
29        ]
30    },
31    "segments": {
32        "type": "list",
33        "segments": [
34            {
35                "type": "segment",
36                "id": "seg123",
37                "name": "Active Users",
38                "created_at": 1609459200,
39                "updated_at": 1625097600
40            }
41        ]
42    },
43    "plan": {
44        "type": "plan",
45        "id": "plan123",
46        "name": "Enterprise Plan"
47    },
48    "custom_attributes": {
49        "creation_source": "api"
50    }
51}

Attach contact to conversation
Copy

Add participants who are contacts to a conversation, on behalf of either another contact or an admin.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "conversation_id": "123456789",
4    "customer": {
5        "intercom_user_id": "5f1a2b3c4d5e6f7g8h9i0j"
6    },
7    "attachment_rule": {
8        "admin_id": "987654321"
9    }
10}

Sample Output

1{
2    "customers": [
3        {
4            "type": "contact",
5            "id": "5f1a2b3c4d5e6f7g8h9i0j"
6        }
7    ]
8}

Attach tag to contact
Copy

Tags a single contact.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "contact_id": "5f1a2b3c4d5e6f7g8h9i0j",
4    "tag_id": "1a2b3c4d5e6f7g8h9i0j1k"
5}

Sample Output

1{
2    "type": "tag",
3    "id": "1a2b3c4d5e6f7g8h9i0j1k",
4    "name": "VIP Customer"
5}

Close conversation
Copy

Closes a conversation.

Sample Input

1{
2    "access_token": "dG9rZW4=",
3    "conversation_id": "123456",
4    "admin_id": "987654",
5    "body": "Thank you for contacting us. This conversation is now closed."
6}

Sample Output

1{
2    "type": "conversation",
3    "id": "123456",
4    "created_at": 1623456789,
5    "updated_at": 1623456999,
6    "waiting_since": null,
7    "snoozed_until": null,
8    "source": {
9        "type": "conversation",
10        "id": "123456",
11        "delivered_as": "customer_initiated",
12        "subject": "Product Inquiry",
13        "body": "I have a question about your product.",
14        "author": {
15            "type": "user",
16            "id": "user_abc123",
17            "name": "John Doe",
18            "email": "john.doe@example.com"
19        },
20        "attachments": [],
21        "url": "https://app.intercom.com/a/apps/abc123/conversations/123456"
22    },
23    "contacts": {
24        "type": "contact.list",
25        "contacts": [
26            {
27                "type": "user",
28                "id": "user_abc123"
29            }
30        ]
31    },
32    "first_contact_reply": {
33        "created_at": 1623456800,
34        "type": "conversation_part",
35        "url": "https://app.intercom.com/a/apps/abc123/conversations/123456#conversation-part-987654"
36    },
37    "open": false,
38    "state": "closed",
39    "read": true,
40    "tags": {
41        "type": "tag.list",
42        "tags": [
43            {
44                "id": "tag_123",
45                "name": "Product Inquiry",
46                "type": "tag"
47            }
48        ]
49    },
50    "priority": "not_priority",
51    "sla_applied": null,
52    "statistics": {
53        "type": "conversation_statistics",
54        "time_to_assignment": "00:05:00",
55        "time_to_admin_reply": 300,
56        "time_to_first_close": 600,
57        "time_to_last_close": 600,
58        "median_time_to_reply": 300,
59        "first_contact_reply_at": 1623456800,
60        "first_assignment_at": "2023-06-12T10:00:00Z",
61        "first_admin_reply_at": 1623456900,
62        "first_close_at": 1623456999,
63        "last_assignment_at": "2023-06-12T10:00:00Z",
64        "last_assignment_admin_reply_at": "2023-06-12T10:05:00Z",
65        "last_contact_reply_at": 1623456800,
66        "last_admin_reply_at": 1623456999,
67        "last_close_at": 1623456999,
68        "last_closed_by_id": 987654,
69        "count_reopens": 0,
70        "count_assignments": 1,
71        "count_conversation_parts": 2
72    },
73    "conversation_rating": null,
74    "teammates": {
75        "type": "admin.list",
76        "admins": [
77            {
78                "type": "admin",
79                "id": "987654"
80            }
81        ]
82    },
83    "conversation_parts": {
84        "type": "conversation_part.list",
85        "conversation_parts": [
86            {
87                "type": "conversation_part",
88                "id": "part_123",
89                "part_type": "comment",
90                "body": "Thank you for contacting us. This conversation is now closed.",
91                "created_at": 1623456999,
92                "updated_at": 1623456999,
93                "notified_at": 1623456999,
94                "assigned_to": "987654",
95                "author": {
96                    "id": "987654",
97                    "type": "admin",
98                    "name": "Support Agent",
99                    "email": "support@example.com"
100                },
101                "attachments": [],
102                "external_id": null
103            }
104        ],
105        "total_count": 2
106    },
107    "assignee": {
108        "id": "987654",
109        "type": "admin",
110        "name": "Support Agent",
111        "email": "support@example.com"
112    }
113}

Create contact
Copy

Creates a new contact (user or lead).

Sample Input

1{
2    "access_token": "dG9rZW4=",
3    "role": "user",
4    "external_id": "user_123456",
5    "email": "john.doe@example.com",
6    "phone": "+1234567890",
7    "name": "John Doe",
8    "avatar": "https://example.com/avatar.jpg",
9    "signed_up_at": "2023-05-15T10:30:00Z",
10    "last_seen_at": "2023-05-15T14:45:00Z",
11    "owner_id": 987654,
12    "unsubscribed_from_emails": false,
13    "custom_attributes": [
14        {
15            "key": "account_type",
16            "value": "premium"
17        },
18        {
19            "key": "industry",
20            "value": "technology"
21        }
22    ]
23}

Sample Output

1{
2    "type": "contact",
3    "id": "5f1a2b3c4d5e6f7g8h9i0j",
4    "workspace_id": "abc123def456",
5    "external_id": "user_123456",
6    "role": "user",
7    "email": "john.doe@example.com",
8    "phone": "+1234567890",
9    "name": "John Doe",
10    "avatar": "https://example.com/avatar.jpg",
11    "owner_id": "987654",
12    "social_profiles": {
13        "type": "list",
14        "data": []
15    },
16    "has_hard_bounced": false,
17    "marked_email_as_spam": false,
18    "unsubscribed_from_emails": false,
19    "created_at": 1684147800,
20    "updated_at": 1684147800,
21    "signed_up_at": "2023-05-15T10:30:00Z",
22    "last_seen_at": "2023-05-15T14:45:00Z",
23    "last_replied_at": null,
24    "last_contacted_at": null,
25    "last_email_opened_at": null,
26    "last_email_clicked_at": null,
27    "language_override": null,
28    "browser": null,
29    "browser_version": null,
30    "browser_language": null,
31    "os": null,
32    "location": {
33        "type": "location",
34        "country": null,
35        "region": null,
36        "city": null
37    },
38    "android_app_name": null,
39    "android_app_version": null,
40    "android_device": null,
41    "android_os_version": null,
42    "android_sdk_version": null,
43    "android_last_seen_at": null,
44    "ios_app_name": null,
45    "ios_app_version": null,
46    "ios_device": null,
47    "ios_os_version": null,
48    "ios_sdk_version": null,
49    "ios_last_seen_at": null,
50    "custom_attributes": {
51        "account_type": "premium",
52        "industry": "technology"
53    },
54    "tags": {
55        "type": "list",
56        "data": [],
57        "url": null,
58        "total_count": 0,
59        "has_more": false
60    },
61    "notes": {
62        "type": "list",
63        "data": [],
64        "url": null,
65        "total_count": 0,
66        "has_more": false
67    },
68    "companies": {
69        "type": "list",
70        "data": [],
71        "url": null,
72        "total_count": 0,
73        "has_more": false
74    }
75}

Create conversation
Copy

Creates in-app conversation initiated by a contact (ie. user or lead).

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "from_conversation": {
4        "id": "5f9b2b3c7e8d9c0001234567"
5    },
6    "body": "Hello, I'm having trouble with my account. Can you please help?"
7}

Sample Output

1{
2    "type": "conversation",
3    "id": "6a7b8c9d0e1f2g3h4i5j6k7l",
4    "created_at": 1634567890,
5    "body": "Hello, I'm having trouble with my account. Can you please help?",
6    "message_type": "comment"
7}

Create message as admin
Copy

Creates a message that has been initiated by an admin. The conversation can be either an in-app message or an email.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "message_type": "email",
4    "subject": "Important Update: New Feature Release",
5    "body": "Hello,<br><br>We're excited to announce the release of our new feature. This update includes...<br><br>Best regards,<br>Your Support Team",
6    "template": "personal",
7    "from_conversation": {
8        "id": "1234567"
9    },
10    "to_message": {
11        "type": "user",
12        "id": "user_abc123"
13    }
14}

Sample Output

1{
2    "type": "conversation",
3    "id": "123456789",
4    "created_at": 1623456789,
5    "subject": "Important Update: New Feature Release",
6    "body": "Hello,<br><br>We're excited to announce the release of our new feature. This update includes...<br><br>Best regards,<br>Your Support Team",
7    "message_type": "email",
8    "owner": {
9        "type": "admin",
10        "id": "1234567",
11        "name": "John Doe",
12        "email": "john.doe@example.com",
13        "away_mode_enabled": false,
14        "away_mode_reassign": false,
15        "avatar": {
16            "image_url": "https://example.com/avatar.jpg"
17        }
18    }
19}

Create note
Copy

Create a note to a single contact.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "contact_id": "5f1a2b3c4d5e6f7g8h9i0j",
4    "admin_id": "1a2b3c4d5e6f7g8h9i0j",
5    "body": "Customer requested a demo of our premium features. Follow up next week."
6}

Sample Output

1{
2    "type": "note",
3    "id": "note_1a2b3c4d5e6f7g8h9i0j",
4    "created_at": 1623456789,
5    "contact": {
6        "type": "contact",
7        "id": "5f1a2b3c4d5e6f7g8h9i0j"
8    },
9    "author": {
10        "type": "admin",
11        "id": "1a2b3c4d5e6f7g8h9i0j",
12        "name": "John Doe",
13        "email": "john.doe@example.com",
14        "away_mode_enabled": false,
15        "away_mode_reassign": false,
16        "avatar": {
17            "image_url": "https://example.com/avatars/john_doe.jpg"
18        }
19    },
20    "body": "Customer requested a demo of our premium features. Follow up next week."
21}

Create/update company
Copy

Create or update a company in Intercom.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODk=",
3    "company_id": "comp_123456",
4    "company_name": "Acme Corporation",
5    "industry": "Technology",
6    "size": 500,
7    "website": "https://www.acmecorp.com",
8    "monthly_spend": 10000,
9    "plan": "Enterprise",
10    "remote_created_at": "2023-05-15T10:30:00Z",
11    "custom_attributes_company": [
12        {
13            "key": "account_manager",
14            "value": "John Doe"
15        },
16        {
17            "key": "customer_since",
18            "value": "2020-01-01"
19        }
20    ]
21}

Sample Output

1{
2    "type": "company",
3    "company_id": "comp_123456",
4    "id": "5f7b5e9c7f8b9a0001234567",
5    "app_id": "abc123xyz456",
6    "name": "Acme Corporation",
7    "remote_created_at": 1684145400,
8    "created_at": 1684145410,
9    "updated_at": 1684145410,
10    "monthly_spend": 10000,
11    "session_count": 0,
12    "user_count": 50,
13    "size": 500,
14    "website": "https://www.acmecorp.com",
15    "industry": "Technology",
16    "tags": {
17        "type": "list",
18        "tags": [
19            {
20                "type": "tag",
21                "id": "tag_123",
22                "name": "Enterprise"
23            }
24        ]
25    },
26    "segments": {
27        "type": "list",
28        "segments": [
29            {
30                "type": "segment",
31                "id": "seg_456"
32            }
33        ]
34    },
35    "plan": {
36        "type": "plan",
37        "id": "plan_789",
38        "name": "Enterprise"
39    },
40    "custom_attributes": {
41        "creation_source": "api",
42        "account_manager": "John Doe",
43        "customer_since": "2020-01-01"
44    }
45}

Delete contact
Copy

Delete a single contact.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "contact_id": "5f1a2b3c4d5e6f7g8h9i0j"
4}

Sample Output

1{
2    "id": "5f1a2b3c4d5e6f7g8h9i0j",
3    "object": "contact",
4    "deleted": true
5}

Detach contact from company
Copy

Detaches a single contact from a company.

Sample Input

1{
2    "access_token": "dG9rZW4=",
3    "company_id": "5f8b3a1b9d8f1e2a3c4b5d6e",
4    "contact_id": "6a7b8c9d0e1f2g3h4i5j6k7"
5}

Sample Output

1{
2    "type": "company",
3    "company_id": "5f8b3a1b9d8f1e2a3c4b5d6e",
4    "id": "5f8b3a1b9d8f1e2a3c4b5d6e",
5    "app_id": "abc123xyz456",
6    "name": "Acme Corporation",
7    "remote_created_at": 1605024000,
8    "created_at": 1605024000,
9    "updated_at": 1621036800,
10    "monthly_spend": 5000,
11    "session_count": 1250,
12    "user_count": 50,
13    "size": 100,
14    "website": "https://www.acmecorp.com",
15    "industry": "Technology",
16    "tags": {
17        "type": "list",
18        "tags": [
19            {
20                "type": "tag",
21                "name": "Enterprise",
22                "id": "tag_123"
23            },
24            {
25                "type": "tag",
26                "name": "High Value",
27                "id": "tag_456"
28            }
29        ]
30    },
31    "segments": {
32        "type": "list",
33        "segments": [
34            {
35                "type": "segment",
36                "id": "seg_789",
37                "name": "Active Users",
38                "created_at": 1605024000,
39                "updated_at": 1621036800
40            }
41        ]
42    },
43    "plan": {
44        "type": "plan",
45        "id": "plan_premium",
46        "name": "Premium"
47    },
48    "custom_attributes": {
49        "creation_source": "api"
50    }
51}

Detach contact from conversation
Copy

Detach contact from conversation.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "conversation_id": "123456789",
4    "contact_id": "987654321",
5    "admin_id": "admin_123"
6}

Sample Output

1{
2    "customers": [
3        {
4            "type": "contact",
5            "id": "987654321"
6        }
7    ]
8}

Detach tag from contact
Copy

Untags a single contact.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "contact_id": "5f1a2b3c4d5e6f7g8h9i0j",
4    "tag_id": "1a2b3c4d5e6f7g8h9i0j1k"
5}

Sample Output

1{
2    "type": "tag",
3    "id": "1a2b3c4d5e6f7g8h9i0j1k",
4    "name": "VIP Customer"
5}

Get admin
Copy

Get an admin by their id in Intercom.

Sample Input

1{
2    "access_token": "dG9rZW4tMTIzNDU2Nzg5MA==",
3    "admin_id": "5678901234"
4}

Sample Output

1{
2    "type": "admin",
3    "id": "5678901234",
4    "name": "John Doe",
5    "email": "john.doe@example.com",
6    "away_mode_enabled": false,
7    "away_mode_reassign": true,
8    "has_inbox_seat": true,
9    "team_ids": [
10        1,
11        2,
12        3
13    ]
14}

Get company
Copy

Retrieves a company by their Intercom internal ID, company ID, or their name in Intercom.

Sample Input

1{
2    "access_token": "dG9rZW46YWJjMTIzZGVmNDU2",
3    "company_id": "123456",
4    "allow_errors": false
5}

Sample Output

1{
2    "type": "company",
3    "company_id": "123456",
4    "id": "5f8a9b3c2d1e0f7a6b5c4d3e",
5    "app_id": "abc123def456",
6    "name": "Acme Corporation",
7    "created_at": 1602691200,
8    "updated_at": 1634227200,
9    "last_request_at": 1634313600,
10    "monthly_spend": 5000,
11    "session_count": 250,
12    "user_count": 50,
13    "tags": {
14        "type": "list",
15        "tags": [
16            {
17                "type": "tag",
18                "name": "Enterprise",
19                "id": "tag_123"
20            },
21            {
22                "type": "tag",
23                "name": "High Value",
24                "id": "tag_456"
25            }
26        ]
27    },
28    "segments": {
29        "type": "list",
30        "segments": [
31            {
32                "type": "segment",
33                "id": "segment_789"
34            }
35        ]
36    },
37    "plan": {},
38    "custom_attributes": {
39        "industry": "Technology",
40        "account_manager": "John Doe"
41    }
42}

Get contact
Copy

Retrieves the details of a single contact.

Sample Input

1{
2    "access_token": "dG9rZW4tMjM0NTY3ODkwLWFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6",
3    "contact_id": "5f1a2b3c4d5e6f7g8h9i0j"
4}

Sample Output

1{
2    "type": "contact",
3    "id": "5f1a2b3c4d5e6f7g8h9i0j",
4    "workspace_id": "abc123def456ghi789",
5    "external_id": "user_123456",
6    "role": "user",
7    "email": "johndoe@example.com",
8    "phone": "+1234567890",
9    "name": "John Doe",
10    "avatar": "https://example.com/avatar.jpg",
11    "owner_id": "9876543210abcdef",
12    "social_profiles": {
13        "type": "list",
14        "data": [
15            {
16                "type": "social_profile",
17                "name": "twitter",
18                "url": "https://twitter.com/johndoe"
19            },
20            {
21                "type": "social_profile",
22                "name": "linkedin",
23                "url": "https://www.linkedin.com/in/johndoe"
24            }
25        ]
26    },
27    "has_hard_bounced": false,
28    "marked_email_as_spam": false,
29    "unsubscribed_from_emails": false,
30    "created_at": 1609459200,
31    "updated_at": 1625097600,
32    "signed_up_at": "2021-01-01T00:00:00.000Z",
33    "last_seen_at": "2021-07-01T12:00:00.000Z",
34    "last_replied_at": "2021-06-15T09:30:00.000Z",
35    "last_contacted_at": "2021-06-30T14:45:00.000Z",
36    "last_email_opened_at": "2021-06-28T10:15:00.000Z",
37    "last_email_clicked_at": "2021-06-28T10:20:00.000Z",
38    "language_override": "en",
39    "browser": "Chrome",
40    "browser_version": "91.0.4472.124",
41    "browser_language": "en-US",
42    "os": "macOS",
43    "location": {
44        "type": "location",
45        "country": "United States",
46        "region": "California",
47        "city": "San Francisco"
48    },
49    "android_app_name": null,
50    "android_app_version": null,
51    "android_device": null,
52    "android_os_version": null,
53    "android_sdk_version": null,
54    "android_last_seen_at": null,
55    "ios_app_name": "ExampleApp",
56    "ios_app_version": "2.1.0",
57    "ios_device": "iPhone12,1",
58    "ios_os_version": "14.6",
59    "ios_sdk_version": "1.2.3",
60    "ios_last_seen_at": "2021-06-30T18:30:00.000Z",
61    "custom_attributes": {
62        "plan": "premium",
63        "account_type": "business",
64        "last_purchase_date": "2021-06-25"
65    },
66    "tags": {
67        "type": "list",
68        "data": [
69            {
70                "type": "tag",
71                "id": "tag123",
72                "url": "https://api.intercom.io/tags/tag123"
73            },
74            {
75                "type": "tag",
76                "id": "tag456",
77                "url": "https://api.intercom.io/tags/tag456"
78            }
79        ],
80        "url": "https://api.intercom.io/contacts/5f1a2b3c4d5e6f7g8h9i0j/tags",
81        "total_count": 2,
82        "has_more": false
83    },
84    "notes": {
85        "type": "list",
86        "data": [
87            {
88                "type": "note",
89                "id": "note789",
90                "url": "https://api.intercom.io/notes/note789"
91            }
92        ],
93        "url": "https://api.intercom.io/contacts/5f1a2b3c4d5e6f7g8h9i0j/notes",
94        "total_count": 1,
95        "has_more": false
96    },
97    "companies": {
98        "type": "list",
99        "data": [
100            {
101                "type": "company",
102                "id": "comp123",
103                "url": "https://api.intercom.io/companies/comp123"
104            }
105        ],
106        "url": "https://api.intercom.io/contacts/5f1a2b3c4d5e6f7g8h9i0j/companies",
107        "total_count": 1,
108        "has_more": false
109    }
110}

Get conversation
Copy

Retrives the details of a single conversation.

Sample Input

1{
2    "access_token": "dG9rZW4tMTIzNDU2Nzg5MA==",
3    "conversation_id": "123456",
4    "display_as_plain_text": true
5}

Sample Output

1{
2    "type": "conversation",
3    "id": "123456",
4    "created_at": 1623456789,
5    "updated_at": 1623457890,
6    "waiting_since": 1623458901,
7    "snoozed_until": "2023-06-15T10:00:00Z",
8    "source": {
9        "type": "email",
10        "id": "789012",
11        "delivered_as": "email",
12        "subject": "Need help with product",
13        "body": "Hi, I'm having trouble with your product. Can you help?",
14        "author": {
15            "type": "user",
16            "id": "user_123",
17            "name": "John Doe",
18            "email": "john.doe@example.com"
19        },
20        "attachments": [
21            {
22                "type": "image",
23                "name": "screenshot.png",
24                "url": "https://example.com/attachments/screenshot.png",
25                "content_type": "image/png",
26                "filesize": 1024000,
27                "width": "800",
28                "height": "600"
29            }
30        ],
31        "url": "https://app.intercom.com/a/apps/abc123/conversations/123456"
32    },
33    "contacts": {
34        "type": "contact.list",
35        "contacts": [
36            {
37                "type": "user",
38                "id": "user_123"
39            }
40        ]
41    },
42    "first_contact_reply": {
43        "created_at": 1623457000,
44        "type": "conversation_part",
45        "url": "https://app.intercom.com/a/apps/abc123/conversations/123456#conversation-part-987654"
46    },
47    "open": true,
48    "state": "open",
49    "read": false,
50    "tags": {
51        "type": "tag.list",
52        "tags": [
53            {
54                "id": "tag_123",
55                "name": "Support",
56                "type": "tag"
57            }
58        ]
59    },
60    "priority": "normal",
61    "sla_applied": "standard",
62    "statistics": {
63        "time_to_assignment": 300,
64        "time_to_admin_reply": 600,
65        "time_to_first_close": 3600,
66        "time_to_last_close": 3600,
67        "median_time_to_reply": 450,
68        "first_contacat_reply_at": 1623457000,
69        "first_assignment_at": 1623456900,
70        "first_admin_reply_at": 1623457300,
71        "first_close_at": 1623460389,
72        "last_assignment_at": 1623456900,
73        "last_assignment_admin_reply_at": 1623457300,
74        "last_contact_reply_at": 1623457000,
75        "last_admin_reply_at": 1623457300,
76        "last_close_at": 1623460389,
77        "last_closed_by": {
78            "type": "admin",
79            "id": "admin_456",
80            "name": "Support Agent",
81            "email": "agent@company.com"
82        }
83    },
84    "conversation_parts": {
85        "type": "conversation_part.list",
86        "conversation_parts": [
87            {
88                "type": "conversation_part",
89                "id": "part_123",
90                "part_type": "comment",
91                "body": "Sure, I'd be happy to help. Can you please provide more details about the issue you're experiencing?",
92                "created_at": 1623457300,
93                "updated_at": 1623457300,
94                "notified_at": 1623457301,
95                "assigned_to": {
96                    "type": "admin",
97                    "id": "admin_456"
98                },
99                "author": {
100                    "type": "admin",
101                    "id": "admin_456"
102                },
103                "attachments": [],
104                "external_id": "reply_1"
105            }
106        ],
107        "total_count": 1
108    },
109    "teammates": {
110        "type": "admin.list",
111        "admins": [
112            {
113                "id": "admin_456",
114                "type": "admin",
115                "name": "Support Agent",
116                "email": "agent@company.com"
117            }
118        ]
119    },
120    "assignee": {
121        "id": "admin_456",
122        "type": "admin",
123        "name": "Support Agent",
124        "email": "agent@company.com"
125    }
126}

Get current user
Copy

Returns data about the current user.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo="
3}

Sample Output

1{
2    "found": true,
3    "body": {
4        "type": "user",
5        "id": "5f1a2b3c4d5e6f7g8h9i0j",
6        "user_id": "user_123456",
7        "anonymous": false,
8        "email": "john.doe@example.com",
9        "name": "John Doe",
10        "pseudonym": "Happy Elephant",
11        "avatar": {
12            "type": "avatar",
13            "image_url": "https://example.com/avatars/john_doe.jpg"
14        },
15        "app_id": "abc123def456",
16        "companies": {
17            "type": "list",
18            "companies": [
19                {
20                    "type": "company",
21                    "company_id": "comp_987654",
22                    "id": "5a1b2c3d4e5f6g7h8i9j0k",
23                    "name": "Acme Corporation"
24                }
25            ]
26        },
27        "location_data": {
28            "type": "location_data",
29            "city_name": "San Francisco",
30            "continent_code": "NA",
31            "country_name": "United States",
32            "latitude": "37.7749",
33            "longitude": "-122.4194",
34            "postal_code": "94105",
35            "region_name": "California",
36            "timezone": "America/Los_Angeles",
37            "country_code": "US"
38        },
39        "last_request_at": 1623456789,
40        "last_seen_ip": "192.168.1.1",
41        "created_at": 1600000000,
42        "remote_created_at": 1599999999,
43        "signed_up_at": 1599999999,
44        "updated_at": 1623456789,
45        "session_count": 42,
46        "social_profiles": {
47            "type": "list",
48            "social_profiles": [
49                {
50                    "name": "twitter",
51                    "id": "87654321",
52                    "username": "johndoe",
53                    "url": "https://twitter.com/johndoe"
54                }
55            ]
56        },
57        "unsubscribed_from_emails": false,
58        "user_agent_data": {},
59        "tags": {
60            "type": "list",
61            "tags": [
62                {
63                    "type": "tag",
64                    "name": "VIP",
65                    "id": "tag_123456"
66                }
67            ]
68        },
69        "segments": {
70            "type": "list",
71            "segments": [
72                {
73                    "type": "segment",
74                    "id": "5b1c2d3e4f5g6h7i8j9k0l",
75                    "name": "Active Users",
76                    "created_at": 1600000001,
77                    "updated_at": 1623456790
78                }
79            ]
80        }
81    }
82}

Get note
Copy

Returns a note.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "note_id": "123456789"
4}

Sample Output

1{
2    "type": "note",
3    "id": "123456789",
4    "created_at": 1623456789,
5    "contact": {
6        "type": "contact",
7        "id": "987654321"
8    },
9    "author": {
10        "type": "admin",
11        "id": "admin_123",
12        "name": "John Doe",
13        "email": "john.doe@example.com",
14        "away_mode_enabled": false,
15        "away_mode_reassign": false
16    },
17    "body": "This customer requested a demo of our premium features. Follow up next week."
18}

Get team
Copy

Retrieves a team using an ID.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "team_id": "1234567890"
4}

Sample Output

1{
2    "type": "team",
3    "id": "1234567890",
4    "name": "Customer Support",
5    "admin_ids": [
6        123,
7        456,
8        789
9    ]
10}

List admins
Copy

Get a list of all the admins in Intercom.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo="
3}

Sample Output

1{
2    "type": "admin.list",
3    "admins": [
4        {
5            "type": "admin",
6            "email": "john.doe@example.com",
7            "id": "5678901234",
8            "name": "John Doe",
9            "away_mode_enabled": false,
10            "away_mode_reassign": true,
11            "has_inbox_seat": true,
12            "team_ids": [
13                1,
14                2,
15                3
16            ]
17        },
18        {
19            "type": "admin",
20            "email": "jane.smith@example.com",
21            "id": "6789012345",
22            "name": "Jane Smith",
23            "away_mode_enabled": true,
24            "away_mode_reassign": false,
25            "has_inbox_seat": true,
26            "team_ids": [
27                2,
28                4
29            ]
30        }
31    ]
32}

List attached companies
Copy

Retrieves a list of companies that are associated to a contact.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "contact_id": "5f1a2b3c4d5e6f7g8h9i0j",
4    "per_page": 50,
5    "page": 1
6}

Sample Output

1{
2    "type": "list",
3    "pages": {
4        "type": "pages",
5        "next": "https://api.intercom.io/companies?contact_id=5f1a2b3c4d5e6f7g8h9i0j&per_page=50&page=2",
6        "page": 1,
7        "per_page": 50,
8        "total_pages": 3
9    },
10    "companies": [
11        {
12            "type": "company",
13            "company_id": "abc123",
14            "id": "5f1a2b3c4d5e6f7g8h9i0j1k",
15            "app_id": "lmn456",
16            "name": "Acme Corporation",
17            "created_at": 1609459200,
18            "updated_at": 1625097600,
19            "last_request_at": 1640995200,
20            "monthly_spend": 1000,
21            "session_count": 250,
22            "user_count": 50,
23            "industry": "Technology",
24            "tags": {
25                "type": "list",
26                "tags": [
27                    {
28                        "type": "tag",
29                        "name": "Enterprise",
30                        "id": "tag123"
31                    },
32                    {
33                        "type": "tag",
34                        "name": "High Value",
35                        "id": "tag456"
36                    }
37                ]
38            },
39            "segments": {
40                "type": "list",
41                "segments": [
42                    {
43                        "type": "segment",
44                        "id": "seg789",
45                        "name": "Active Users",
46                        "created_at": 1609459200,
47                        "updated_at": 1625097600
48                    }
49                ]
50            },
51            "plan": {
52                "type": "plan",
53                "id": "plan101",
54                "name": "Enterprise"
55            },
56            "custom_attributes": {
57                "account_manager": "John Doe",
58                "renewal_date": "2023-12-31"
59            }
60        }
61    ],
62    "total_count": 125
63}

List attached tags
Copy

Retrieves a list of tags that are associated to a contact.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "contact_id": "5f1a2b3c4d5e6f7g8h9i0j"
4}

Sample Output

1{
2    "type": "list",
3    "tags": [
4        {
5            "type": "tag",
6            "id": "123456",
7            "name": "VIP Customer"
8        },
9        {
10            "type": "tag",
11            "id": "789012",
12            "name": "Product Feedback"
13        },
14        {
15            "type": "tag",
16            "id": "345678",
17            "name": "Support Tier 1"
18        }
19    ]
20}

List companies
Copy

Get a list of companies in Intercom.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "segment_id": "5f1a2b3c4d5e6f7g8h9i0j",
4    "order": "desc",
5    "page": 1,
6    "per_page": 50
7}

Sample Output

1{
2    "type": "list",
3    "data": [
4        {
5            "type": "company",
6            "company_id": "5f9a1b2c3d4e5f6g7h8i9j0",
7            "id": "5f9a1b2c3d4e5f6g7h8i9j0",
8            "app_id": "abc123def456",
9            "name": "Acme Corporation",
10            "created_at": 1609459200,
11            "updated_at": 1625097600,
12            "last_request_at": 1625184000,
13            "monthly_spend": 5000,
14            "session_count": 1250,
15            "user_count": 75,
16            "tags": {
17                "type": "list",
18                "tags": [
19                    {
20                        "type": "tag",
21                        "id": "tag123",
22                        "name": "Enterprise"
23                    },
24                    {
25                        "type": "tag",
26                        "id": "tag456",
27                        "name": "High Value"
28                    }
29                ]
30            },
31            "segments": {
32                "type": "list",
33                "segments": [
34                    {
35                        "created_at": 1609459200,
36                        "id": "5f1a2b3c4d5e6f7g8h9i0j",
37                        "name": "Active Users",
38                        "type": "segment",
39                        "updated_at": 1625097600
40                    }
41                ]
42            },
43            "plan": {
44                "type": "plan",
45                "id": "plan789",
46                "name": "Enterprise"
47            },
48            "custom_attributes": {
49                "industry": "Technology",
50                "employees": 500,
51                "location": "New York"
52            }
53        }
54    ],
55    "pages": {
56        "type": "pages",
57        "next": "https://api.intercom.io/companies?page=2",
58        "page": 1,
59        "per_page": 50,
60        "total_pages": 10
61    },
62    "total_count": 500
63}

List contacts
Copy

Retrieves a list of all contacts.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "per_page": 50,
4    "starting_after": "contact_5f9b2b3c7e8d9a0001234567"
5}

Sample Output

1{
2    "type": "list",
3    "data": [
4        {
5            "type": "contact",
6            "id": "5f9b2b3c7e8d9a0001234568",
7            "workspace_id": "abc123",
8            "external_id": "user_123",
9            "role": "user",
10            "email": "john.doe@example.com",
11            "phone": "+1234567890",
12            "name": "John Doe",
13            "avatar": "https://example.com/avatar.jpg",
14            "owner_id": "5f9b2b3c7e8d9a0001234569",
15            "social_profiles": {
16                "type": "list",
17                "data": [
18                    {
19                        "type": "social_profile",
20                        "name": "twitter",
21                        "url": "https://twitter.com/johndoe"
22                    }
23                ]
24            },
25            "has_hard_bounced": false,
26            "marked_email_as_spam": false,
27            "unsubscribed_from_emails": false,
28            "created_at": 1603987200,
29            "updated_at": 1604073600,
30            "signed_up_at": "2020-10-29T12:00:00Z",
31            "last_seen_at": "2021-03-15T09:30:00Z",
32            "last_replied_at": "2021-03-10T14:45:00Z",
33            "last_contacted_at": "2021-03-12T11:20:00Z",
34            "last_email_opened_at": "2021-03-14T16:00:00Z",
35            "last_email_clicked_at": "2021-03-14T16:05:00Z",
36            "language_override": "en",
37            "browser": "Chrome",
38            "browser_version": "89.0.4389.82",
39            "browser_language": "en-US",
40            "os": "macOS",
41            "location": {
42                "type": "location",
43                "country": "United States",
44                "region": "California",
45                "city": "San Francisco"
46            },
47            "android_app_name": null,
48            "android_app_version": null,
49            "android_device": null,
50            "android_os_version": null,
51            "android_sdk_version": null,
52            "android_last_seen_at": null,
53            "ios_app_name": "ExampleApp",
54            "ios_app_version": "2.1.0",
55            "ios_device": "iPhone12,1",
56            "ios_os_version": "14.4",
57            "ios_sdk_version": "1.2.3",
58            "ios_last_seen_at": "2021-03-15T09:30:00Z",
59            "custom_attributes": {
60                "plan": "premium",
61                "last_purchase": "2021-02-28"
62            },
63            "tags": {
64                "type": "list",
65                "data": [
66                    {
67                        "type": "tag",
68                        "id": "5f9b2b3c7e8d9a0001234570",
69                        "url": "https://api.intercom.io/tags/5f9b2b3c7e8d9a0001234570"
70                    }
71                ],
72                "url": "https://api.intercom.io/contacts/5f9b2b3c7e8d9a0001234568/tags",
73                "total_count": 1,
74                "has_more": false
75            },
76            "notes": {
77                "type": "list",
78                "data": [
79                    {
80                        "type": "note",
81                        "id": "5f9b2b3c7e8d9a0001234571",
82                        "url": "https://api.intercom.io/notes/5f9b2b3c7e8d9a0001234571"
83                    }
84                ],
85                "url": "https://api.intercom.io/contacts/5f9b2b3c7e8d9a0001234568/notes",
86                "total_count": 1,
87                "has_more": false
88            },
89            "companies": {
90                "type": "list",
91                "data": [
92                    {
93                        "type": "company",
94                        "id": "5f9b2b3c7e8d9a0001234572",
95                        "url": "https://api.intercom.io/companies/5f9b2b3c7e8d9a0001234572"
96                    }
97                ],
98                "url": "https://api.intercom.io/contacts/5f9b2b3c7e8d9a0001234568/companies",
99                "total_count": 1,
100                "has_more": false
101            }
102        }
103    ],
104    "total_count": 1,
105    "pages": {
106        "type": "pages",
107        "next": {
108            "page": 2,
109            "starting_after": "5f9b2b3c7e8d9a0001234568"
110        },
111        "page": 1,
112        "per_page": 50,
113        "total_pages": 1
114    }
115}

List contacts attached to company
Copy

Retrieves a list of all contacts that belong to a company.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "company_id": "5f7b5e1a9b7c8d0001234567",
4    "per_page": 50,
5    "starting_after": "contact_5f7b5e1a9b7c8d0001234568"
6}

Sample Output

1{
2    "type": "list",
3    "data": [
4        {
5            "type": "contact",
6            "id": "5f7b5e1a9b7c8d0001234569",
7            "workspace_id": "abc123",
8            "external_id": "user_123",
9            "role": "user",
10            "email": "john.doe@example.com",
11            "phone": "+1234567890",
12            "name": "John Doe",
13            "avatar": "https://example.com/avatar.jpg",
14            "owner_id": "5f7b5e1a9b7c8d0001234570",
15            "social_profiles": {
16                "type": "list",
17                "data": [
18                    {
19                        "type": "social_profile",
20                        "name": "twitter",
21                        "url": "https://twitter.com/johndoe"
22                    }
23                ]
24            },
25            "has_hard_bounced": false,
26            "marked_email_as_spam": false,
27            "unsubscribed_from_emails": false,
28            "created_at": 1601913600,
29            "updated_at": 1602000000,
30            "signed_up_at": "2020-10-05T12:00:00Z",
31            "last_seen_at": "2021-03-15T09:30:00Z",
32            "last_replied_at": 1615800000,
33            "last_contacted_at": "2021-03-10T14:00:00Z",
34            "last_email_opened_at": "2021-03-12T10:15:00Z",
35            "last_email_clicked_at": "2021-03-12T10:20:00Z",
36            "language_override": "en",
37            "browser": "Chrome",
38            "browser_version": "89.0.4389.82",
39            "browser_language": "en-US",
40            "os": "macOS",
41            "location": {
42                "type": "location",
43                "country": "United States",
44                "region": "California",
45                "city": "San Francisco"
46            },
47            "android_app_name": null,
48            "android_app_version": null,
49            "android_device": null,
50            "android_os_version": null,
51            "android_sdk_version": null,
52            "android_last_seen_at": null,
53            "ios_app_name": "ExampleApp",
54            "ios_app_version": "2.1.0",
55            "ios_device": "iPhone12,1",
56            "ios_os_version": "14.4",
57            "ios_sdk_version": "1.2.3",
58            "ios_last_seen_at": "2021-03-15T09:30:00Z",
59            "custom_attributes": {
60                "invitee": "Jane Smith"
61            },
62            "tags": {
63                "type": "list",
64                "data": [
65                    {
66                        "type": "tag",
67                        "id": "5f7b5e1a9b7c8d0001234571",
68                        "url": "https://api.intercom.io/tags/5f7b5e1a9b7c8d0001234571"
69                    }
70                ],
71                "url": "https://api.intercom.io/contacts/5f7b5e1a9b7c8d0001234569/tags",
72                "total_count": 1,
73                "has_more": false
74            },
75            "notes": {
76                "type": "list",
77                "data": [
78                    {
79                        "type": "note",
80                        "id": "5f7b5e1a9b7c8d0001234572",
81                        "url": "https://api.intercom.io/notes/5f7b5e1a9b7c8d0001234572"
82                    }
83                ],
84                "url": "https://api.intercom.io/contacts/5f7b5e1a9b7c8d0001234569/notes",
85                "total_count": 1,
86                "has_more": false
87            },
88            "companies": {
89                "type": "list",
90                "data": [
91                    {
92                        "id": "5f7b5e1a9b7c8d0001234567",
93                        "type": "company",
94                        "url": "https://api.intercom.io/companies/5f7b5e1a9b7c8d0001234567"
95                    }
96                ],
97                "url": "https://api.intercom.io/contacts/5f7b5e1a9b7c8d0001234569/companies",
98                "total_count": 1,
99                "has_more": false
100            }
101        }
102    ],
103    "total_count": 1,
104    "pages": {
105        "type": "pages",
106        "page": 1,
107        "per_page": 50,
108        "total_pages": 1
109    }
110}

List conversations
Copy

Retrieves a list of all conversations.

Sample Input

1{
2    "access_token": "dG9rZW4=",
3    "order": "desc",
4    "sort": "updated_at",
5    "per_page": 50,
6    "page": 1
7}

Sample Output

1{
2    "type": "conversation.list",
3    "pages": {
4        "type": "pages",
5        "next": "https://api.intercom.io/conversations?per_page=50&page=2",
6        "page": 1,
7        "per_page": 50,
8        "total_pages": 3
9    },
10    "total_count": 125,
11    "conversations": [
12        {
13            "type": "conversation",
14            "id": "123456789",
15            "created_at": 1623456789,
16            "updated_at": 1623567890,
17            "waiting_since": 1623567890,
18            "snoozed_until": null,
19            "source": {
20                "type": "conversation",
21                "id": "987654321",
22                "delivered_as": "customer_initiated",
23                "subject": "Need help with integration",
24                "body": "Hi, I'm having trouble integrating your API. Can you help?",
25                "author": {
26                    "type": "user",
27                    "id": "user_123",
28                    "name": "John Doe",
29                    "email": "john.doe@example.com"
30                },
31                "attachments": [],
32                "url": "https://app.intercom.com/a/apps/abc123/conversations/987654321"
33            },
34            "contacts": {
35                "type": "contact.list",
36                "contacts": [
37                    {
38                        "type": "contact",
39                        "id": "5f7b5e8c7b44b30c9a9b1234"
40                    }
41                ]
42            },
43            "first_contact_reply": {
44                "created_at": 1623567891,
45                "type": "conversation_part",
46                "url": "https://app.intercom.com/a/apps/abc123/conversations/987654321"
47            },
48            "open": true,
49            "state": "open",
50            "read": false,
51            "tags": {
52                "type": "tag.list",
53                "tags": [
54                    {
55                        "id": "4567890",
56                        "name": "Integration",
57                        "type": "tag"
58                    }
59                ]
60            },
61            "priority": "normal",
62            "sla_applied": null,
63            "statistics": {
64                "type": "conversation_statistics",
65                "time_to_assignment": "1h",
66                "time_to_admin_reply": "2h",
67                "time_to_first_close": null,
68                "time_to_last_close": null,
69                "median_time_to_reply": "30m",
70                "first_contact_reply_at": 1623567891,
71                "first_assignment_at": "2023-06-13T10:30:00Z",
72                "first_admin_reply_at": "2023-06-13T11:30:00Z",
73                "first_close_at": null,
74                "last_assignment_at": "2023-06-13T10:30:00Z",
75                "last_assignment_admin_reply_at": "2023-06-13T11:30:00Z",
76                "last_contact_reply_at": 1623567891,
77                "last_admin_reply_at": "2023-06-13T11:30:00Z",
78                "last_close_at": null,
79                "last_closed_by_id": null,
80                "count_reopens": 0,
81                "count_assignments": 1,
82                "count_conversation_parts": 2
83            },
84            "conversation_rating": null,
85            "teammates": {
86                "type": "admin.list",
87                "admins": [
88                    {
89                        "id": "3456789",
90                        "type": "admin",
91                        "name": "Support Team",
92                        "email": "support@company.com"
93                    }
94                ]
95            },
96            "assignee": {
97                "id": "3456789",
98                "type": "admin",
99                "name": "Support Team",
100                "email": "support@company.com"
101            }
102        }
103    ]
104}

List data attributes
Copy

Retrieves a list of available data attributes.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "model": "contact",
4    "include_archived": true
5}

Sample Output

1{
2    "type": "list",
3    "data": [
4        {
5            "type": "data_attribute",
6            "model": "contact",
7            "name": "job_title",
8            "full_name": "job_title",
9            "label": "Job Title",
10            "description": "The job title of the contact",
11            "data_type": "string",
12            "options": [],
13            "api_writable": true,
14            "ui_writable": true,
15            "custom": false,
16            "archived": false,
17            "admin_id": "1234567",
18            "created_at": 1623456789,
19            "updated_at": 1623456789
20        },
21        {
22            "type": "data_attribute",
23            "model": "contact",
24            "name": "industry",
25            "full_name": "industry",
26            "label": "Industry",
27            "description": "The industry the contact works in",
28            "data_type": "string",
29            "options": [
30                "Technology",
31                "Finance",
32                "Healthcare",
33                "Education"
34            ],
35            "api_writable": true,
36            "ui_writable": true,
37            "custom": true,
38            "archived": false,
39            "admin_id": "2345678",
40            "created_at": 1623456790,
41            "updated_at": 1623456790
42        }
43    ]
44}

List data events
Copy

Retrieves a list of all data events that are less than 90 days old.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "external_user_id": "user_123456",
4    "email": "johndoe@example.com",
5    "intercom_user_id": "5f1a2b3c4d5e6f7g8h9i0j",
6    "summary": true,
7    "per_page": 25
8}

Sample Output

1{
2    "type": "list",
3    "events": [
4        {
5            "type": "event",
6            "id": "ev_123456789",
7            "created_at": 1623456789,
8            "event_name": "purchased_item",
9            "user_id": "user_123456",
10            "email": "johndoe@example.com",
11            "intercom_user_id": "5f1a2b3c4d5e6f7g8h9i0j",
12            "metadata": {
13                "friend": "Jane Smith",
14                "load": 2.5,
15                "created_date": 1623456700,
16                "article": {
17                    "url": "https://example.com/blog/new-product",
18                    "value": "New Product Launch"
19                },
20                "price": {
21                    "amount": 99.99,
22                    "currency": "USD"
23                },
24                "food": "Pizza"
25            }
26        }
27    ],
28    "pages": {
29        "since": "2023-06-12T10:30:00Z"
30    }
31}

List notes
Copy

Retrieves a list of all notes.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "contact_id": "5f1a2b3c4d5e6f7g8h9i0j",
4    "per_page": 50,
5    "page": 1
6}

Sample Output

1{
2    "type": "list",
3    "data": [
4        {
5            "type": "note",
6            "id": "123456789",
7            "created_at": 1623456789,
8            "body": "Customer requested a demo of our enterprise plan",
9            "author": {
10                "type": "admin",
11                "id": "987654321",
12                "name": "John Doe",
13                "email": "john.doe@example.com",
14                "companies": [
15                    {
16                        "type": "company",
17                        "id": "comp_123456",
18                        "name": "Acme Inc",
19                        "plan": {
20                            "type": "plan",
21                            "id": "plan_123",
22                            "name": "Enterprise"
23                        },
24                        "company_id": "acme123",
25                        "remote_created_at": 1600000000,
26                        "created_at": 1600000000,
27                        "updated_at": 1623456789,
28                        "size": 500,
29                        "website": "https://www.acme.com",
30                        "industry": "Technology",
31                        "monthly_spend": 5000,
32                        "session_count": 1000,
33                        "user_count": 50,
34                        "custom_attributes": {
35                            "paid_subscriber": true,
36                            "team_mates": 5
37                        }
38                    }
39                ]
40            },
41            "user": {
42                "type": "user",
43                "id": "5f1a2b3c4d5e6f7g8h9i0j"
44            }
45        }
46    ],
47    "total_count": 1,
48    "pages": {
49        "type": "pages",
50        "next": null,
51        "page": 1,
52        "per_page": 50,
53        "total_pages": 1
54    }
55}

List segments
Copy

Retrieves a list of all segments.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "include_count": true
4}

Sample Output

1{
2    "type": "list",
3    "segments": [
4        {
5            "type": "segment",
6            "id": "5f1a2b3c4d5e6f7g8h9i0j",
7            "name": "Active Users",
8            "created_at": 1623456789,
9            "updated_at": 1634567890,
10            "person_type": "user",
11            "count": 1250
12        },
13        {
14            "type": "segment",
15            "id": "0a1b2c3d4e5f6g7h8i9j0k",
16            "name": "Inactive Users",
17            "created_at": 1612345678,
18            "updated_at": 1623456789,
19            "person_type": "user",
20            "count": 500
21        },
22        {
23            "type": "segment",
24            "id": "9z8y7x6w5v4u3t2s1r0q",
25            "name": "Premium Customers",
26            "created_at": 1601234567,
27            "updated_at": 1612345678,
28            "person_type": "lead",
29            "count": 750
30        }
31    ]
32}

Retrieves a list of all tags.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo="
3}

Sample Output

1{
2    "type": "list",
3    "data": [
4        {
5            "type": "tag",
6            "id": "4f73428b5e4dfc000b000112",
7            "name": "VIP Customer"
8        },
9        {
10            "type": "tag",
11            "id": "5e8f9c1a7b3c5e000f123456",
12            "name": "New User"
13        },
14        {
15            "type": "tag",
16            "id": "6a1b2c3d4e5f6g7h8i9j0k1l",
17            "name": "Feedback Requested"
18        }
19    ]
20}

List teams
Copy

Retrieves a list of all teams.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo="
3}

Sample Output

1{
2    "type": "list",
3    "teams": [
4        {
5            "type": "team",
6            "id": "123456",
7            "name": "Customer Support",
8            "admin_ids": [
9                1001,
10                1002,
11                1003
12            ]
13        },
14        {
15            "type": "team",
16            "id": "789012",
17            "name": "Sales",
18            "admin_ids": [
19                2001,
20                2002
21            ]
22        },
23        {
24            "type": "team",
25            "id": "345678",
26            "name": "Product Development",
27            "admin_ids": [
28                3001,
29                3002,
30                3003,
31                3004
32            ]
33        }
34    ]
35}

Merge contacts
Copy

Merges a contact with a role of lead into a contact with a role of user. The contact that's specified as from will be deleted after being merged into the contact specified as into. Attributes that don't exist on the contact specified as into will be copied over.

Sample Input

1{
2    "access_token": "dG9rZW4tMTIzNDU2Nzg5MA==",
3    "from": "lead_5f9a8b7c6d5e4f3g2h1i",
4    "into": "user_1a2b3c4d5e6f7g8h9i0j"
5}

Sample Output

1{
2    "type": "contact",
3    "id": "user_1a2b3c4d5e6f7g8h9i0j",
4    "workspace_id": "abc123",
5    "external_id": "cust_987654",
6    "role": "user",
7    "email": "john.doe@example.com",
8    "phone": "+1234567890",
9    "name": "John Doe",
10    "avatar": "https://example.com/avatar.jpg",
11    "owner_id": "owner_9876543210",
12    "social_profiles": {
13        "type": "list",
14        "data": [
15            {
16                "type": "social_profile",
17                "name": "twitter",
18                "url": "https://twitter.com/johndoe"
19            }
20        ]
21    },
22    "has_hard_bounced": false,
23    "marked_email_as_spam": false,
24    "unsubscribed_from_emails": false,
25    "created_at": 1609459200,
26    "updated_at": 1625097600,
27    "signed_up_at": "2021-01-01T00:00:00Z",
28    "last_seen_at": "2021-07-01T12:00:00Z",
29    "last_replied_at": "2021-06-15T09:30:00Z",
30    "last_contacted_at": "2021-06-30T14:45:00Z",
31    "last_email_opened_at": "2021-06-28T10:15:00Z",
32    "last_email_clicked_at": "2021-06-28T10:20:00Z",
33    "language_override": "en",
34    "browser": "Chrome",
35    "browser_version": "91.0.4472.124",
36    "browser_language": "en-US",
37    "os": "macOS",
38    "location": {
39        "type": "location",
40        "country": "United States",
41        "region": "California",
42        "city": "San Francisco"
43    },
44    "custom_attributes": {
45        "plan": "premium",
46        "account_type": "business"
47    },
48    "tags": {
49        "type": "list",
50        "data": [
51            {
52                "type": "tag",
53                "id": "tag_123",
54                "url": "https://api.intercom.io/tags/tag_123"
55            }
56        ],
57        "url": "https://api.intercom.io/contacts/user_1a2b3c4d5e6f7g8h9i0j/tags",
58        "total_count": 1,
59        "has_more": false
60    },
61    "notes": {
62        "type": "list",
63        "data": [
64            {
65                "type": "note",
66                "id": "note_456",
67                "url": "https://api.intercom.io/notes/note_456"
68            }
69        ],
70        "url": "https://api.intercom.io/contacts/user_1a2b3c4d5e6f7g8h9i0j/notes",
71        "total_count": 1,
72        "has_more": false
73    },
74    "companies": {
75        "type": "list",
76        "data": [
77            {
78                "type": "company",
79                "id": "company_789",
80                "url": "https://api.intercom.io/companies/company_789"
81            }
82        ],
83        "url": "https://api.intercom.io/contacts/user_1a2b3c4d5e6f7g8h9i0j/companies",
84        "total_count": 1,
85        "has_more": false
86    }
87}

Open conversation
Copy

Opens a conversation.

Sample Input

1{
2    "access_token": "dG9rZW4tMTIzNDU2Nzg5MA==",
3    "conversation_id": "123456",
4    "admin_id": "987654"
5}

Sample Output

1{
2    "type": "conversation",
3    "id": "123456",
4    "created_at": 1623456789,
5    "updated_at": 1623456890,
6    "waiting_since": "2023-06-12T10:30:00Z",
7    "snoozed_until": null,
8    "source": {
9        "type": "conversation",
10        "id": "123456",
11        "delivered_as": "email",
12        "subject": "Need help with product",
13        "body": "Hi, I'm having trouble with your product. Can you help?",
14        "author": {
15            "type": "user",
16            "id": "user_abc123",
17            "name": "John Doe",
18            "email": "john.doe@example.com"
19        },
20        "attachments": [],
21        "url": "https://app.intercom.com/a/apps/abc123/conversations/123456"
22    },
23    "contacts": {
24        "type": "contact.list",
25        "contacts": [
26            {
27                "type": "user",
28                "id": "user_abc123"
29            }
30        ]
31    },
32    "first_contact_reply": {
33        "created_at": 1623456800,
34        "type": "conversation",
35        "url": "https://app.intercom.com/a/apps/abc123/conversations/123456"
36    },
37    "open": true,
38    "state": "open",
39    "read": true,
40    "tags": {
41        "type": "tag.list",
42        "tags": [
43            {
44                "id": "tag_123",
45                "name": "Support",
46                "type": "tag"
47            }
48        ]
49    },
50    "priority": "normal",
51    "sla_applied": null,
52    "statistics": {
53        "type": "conversation_statistics",
54        "time_to_assignment": "00:05:00",
55        "time_to_admin_reply": 300,
56        "time_to_first_close": null,
57        "time_to_last_close": null,
58        "median_time_to_reply": 300,
59        "first_contact_reply_at": 1623456800,
60        "first_assignment_at": "2023-06-12T10:35:00Z",
61        "first_admin_reply_at": 1623457089,
62        "first_close_at": null,
63        "last_assignment_at": "2023-06-12T10:35:00Z",
64        "last_assignment_admin_reply_at": "2023-06-12T10:38:09Z",
65        "last_contact_reply_at": 1623456800,
66        "last_admin_reply_at": 1623457089,
67        "last_close_at": null,
68        "last_closed_by_id": null,
69        "count_reopens": 0,
70        "count_assignments": 1,
71        "count_conversation_parts": 2
72    },
73    "conversation_rating": null,
74    "teammates": {
75        "type": "admin.list",
76        "admins": [
77            {
78                "type": "admin",
79                "id": "987654"
80            }
81        ]
82    },
83    "conversation_parts": {
84        "type": "conversation_part.list",
85        "conversation_parts": [
86            {
87                "type": "conversation_part",
88                "id": "part_123",
89                "part_type": "comment",
90                "body": "Sure, I'd be happy to help. Can you please provide more details about the issue you're experiencing?",
91                "created_at": 1623457089,
92                "updated_at": 1623457089,
93                "notified_at": 1623457090,
94                "assigned_to": "987654",
95                "author": {
96                    "id": "987654",
97                    "type": "admin",
98                    "name": "Support Agent",
99                    "email": "support@example.com"
100                },
101                "attachments": [],
102                "external_id": null
103            }
104        ],
105        "total_count": 1
106    },
107    "assignee": {
108        "id": "987654",
109        "type": "admin",
110        "name": "Support Agent",
111        "email": "support@example.com"
112    }
113}

Raw HTTP request (advanced)
Copy

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "method": "GET",
4    "url": {
5        "endpoint": "/contacts"
6    },
7    "headers": [
8        {
9            "key": "Accept",
10            "value": "application/json"
11        }
12    ],
13    "query_parameters": [
14        {
15            "key": "limit",
16            "value": "10"
17        }
18    ],
19    "body": {
20        "none": null
21    },
22    "include_raw_body": false,
23    "parse_response": "true"
24}

Sample Output

1{
2    "response": {
3        "status_code": 200,
4        "headers": {
5            "Content-Type": "application/json",
6            "X-RateLimit-Limit": "1000",
7            "X-RateLimit-Remaining": "999"
8        },
9        "body": {
10            "type": "list",
11            "data": [
12                {
13                    "id": "5f1b7ca4e5d9d50c8b5c1234",
14                    "name": "John Doe",
15                    "email": "john.doe@example.com",
16                    "phone": "+1234567890",
17                    "created_at": 1595678884
18                },
19                {
20                    "id": "5f1b7ca4e5d9d50c8b5c5678",
21                    "name": "Jane Smith",
22                    "email": "jane.smith@example.com",
23                    "phone": "+1987654321",
24                    "created_at": 1595679000
25                }
26            ],
27            "total_count": 2,
28            "pages": {
29                "type": "pages",
30                "next": null,
31                "page": 1,
32                "per_page": 10,
33                "total_pages": 1
34            }
35        }
36    }
37}

Reply to conversation
Copy

Replies to a conversation with a message from an admin or on behalf of a contact, or with a note for admins.

Sample Input

1{
2    "access_token": "dG9rZW4=",
3    "conversation": "1234567890",
4    "on_behalf_of": {
5        "admin_id": "3456789012",
6        "message_type": "comment"
7    },
8    "body": "Thank you for reaching out. We're looking into your issue and will get back to you shortly.",
9    "attachment_urls": [
10        "https://example.com/image1.jpg",
11        "https://example.com/image2.png"
12    ]
13}

Sample Output

1{
2    "type": "conversation",
3    "id": "1234567890",
4    "created_at": 1623456789,
5    "updated_at": 1623456999,
6    "waiting_since": null,
7    "snoozed_until": null,
8    "source": {
9        "type": "conversation",
10        "id": "1234567890",
11        "delivered_as": "customer_initiated",
12        "subject": "Need help with product",
13        "body": "Hi, I'm having trouble with...",
14        "author": {
15            "type": "user",
16            "id": "5678901234",
17            "name": "John Doe",
18            "email": "john.doe@example.com"
19        },
20        "attachments": [],
21        "url": null
22    },
23    "contacts": {
24        "type": "contact.list",
25        "contacts": [
26            {
27                "type": "user",
28                "id": "5678901234"
29            }
30        ]
31    },
32    "first_contact_reply": {
33        "created_at": 1623456789,
34        "type": "conversation",
35        "url": null
36    },
37    "open": true,
38    "state": "open",
39    "read": true,
40    "tags": {
41        "type": "tag.list",
42        "tags": []
43    },
44    "priority": "not_priority",
45    "sla_applied": null,
46    "statistics": {
47        "type": "conversation_statistics",
48        "time_to_assignment": null,
49        "time_to_admin_reply": 210,
50        "time_to_first_close": null,
51        "time_to_last_close": null,
52        "median_time_to_reply": 210,
53        "first_contact_reply_at": 1623456789,
54        "first_assignment_at": null,
55        "first_admin_reply_at": 1623456999,
56        "first_close_at": null,
57        "last_assignment_at": null,
58        "last_assignment_admin_reply_at": null,
59        "last_contact_reply_at": 1623456789,
60        "last_admin_reply_at": 1623456999,
61        "last_close_at": null,
62        "last_closed_by_id": null,
63        "count_reopens": 0,
64        "count_assignments": 0,
65        "count_conversation_parts": 2
66    },
67    "conversation_rating": null,
68    "teammates": {
69        "type": "admin.list",
70        "admins": [
71            {
72                "type": "admin",
73                "id": "3456789012"
74            }
75        ]
76    },
77    "conversation_parts": {
78        "type": "conversation_part.list",
79        "conversation_parts": [
80            {
81                "type": "conversation_part",
82                "id": "6789012345",
83                "part_type": "comment",
84                "body": "Thank you for reaching out. We're looking into your issue and will get back to you shortly.",
85                "created_at": 1623456999,
86                "updated_at": 1623456999,
87                "notified_at": 1623456999,
88                "assigned_to": null,
89                "author": {
90                    "id": "3456789012",
91                    "type": "admin",
92                    "name": "Support Agent",
93                    "email": "support@example.com"
94                },
95                "attachments": [
96                    {
97                        "type": "image",
98                        "name": "image1.jpg",
99                        "url": "https://example.com/image1.jpg",
100                        "content_type": "image/jpeg",
101                        "filesize": 102400,
102                        "width": "800",
103                        "height": "600"
104                    },
105                    {
106                        "type": "image",
107                        "name": "image2.png",
108                        "url": "https://example.com/image2.png",
109                        "content_type": "image/png",
110                        "filesize": 81920,
111                        "width": "1024",
112                        "height": "768"
113                    }
114                ],
115                "external_id": null
116            }
117        ],
118        "total_count": 2
119    },
120    "assignee": {
121        "id": "3456789012",
122        "type": "admin",
123        "name": "Support Agent",
124        "email": "support@example.com"
125    }
126}

Search contacts
Copy

Searches for contacts by the value of their attributes.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "query": {
4        "operator": "AND",
5        "value": [
6            {
7                "field": "email",
8                "operator": "~",
9                "value": "@example.com"
10            },
11            {
12                "field": "created_at",
13                "operator": ">",
14                "value": 1609459200
15            }
16        ]
17    },
18    "per_page": 50,
19    "starting_after": "contact_id_123"
20}

Sample Output

1{
2    "type": "list",
3    "data": [
4        {
5            "type": "contact",
6            "id": "5f1a2b3c4d5e6f7g8h9i0j",
7            "workspace_id": "abc123def456",
8            "external_id": "user_12345",
9            "role": "user",
10            "email": "john.doe@example.com",
11            "phone": "+1234567890",
12            "name": "John Doe",
13            "avatar": "https://example.com/avatar.jpg",
14            "owner_id": "9i8h7g6f5e4d3c2b1a0z",
15            "social_profiles": {
16                "type": "list",
17                "data": [
18                    {
19                        "type": "social_profile",
20                        "name": "twitter",
21                        "url": "https://twitter.com/johndoe"
22                    }
23                ]
24            },
25            "has_hard_bounced": false,
26            "marked_email_as_spam": false,
27            "unsubscribed_from_emails": false,
28            "created_at": 1609459200,
29            "updated_at": 1625097600,
30            "signed_up_at": "2021-01-01T00:00:00Z",
31            "last_seen_at": "2023-04-15T10:30:00Z",
32            "last_replied_at": "2023-04-10T15:45:00Z",
33            "last_contacted_at": "2023-04-12T09:20:00Z",
34            "last_email_opened_at": "2023-04-14T11:00:00Z",
35            "last_email_clicked_at": "2023-04-14T11:05:00Z",
36            "language_override": "en",
37            "browser": "Chrome",
38            "browser_version": "112.0.5615.121",
39            "browser_language": "en-US",
40            "os": "macOS",
41            "location": {
42                "type": "location",
43                "country": "United States",
44                "region": "California",
45                "city": "San Francisco"
46            },
47            "custom_attributes": {
48                "plan": "premium",
49                "last_purchase": "2023-04-01"
50            },
51            "tags": {
52                "type": "list",
53                "data": [
54                    {
55                        "type": "tag",
56                        "id": "tag_123",
57                        "url": "https://api.intercom.io/tags/tag_123"
58                    }
59                ],
60                "url": "https://api.intercom.io/contacts/5f1a2b3c4d5e6f7g8h9i0j/tags",
61                "total_count": 1,
62                "has_more": false
63            },
64            "notes": {
65                "type": "list",
66                "data": [
67                    {
68                        "type": "note",
69                        "id": "note_456",
70                        "url": "https://api.intercom.io/notes/note_456"
71                    }
72                ],
73                "url": "https://api.intercom.io/contacts/5f1a2b3c4d5e6f7g8h9i0j/notes",
74                "total_count": 1,
75                "has_more": false
76            },
77            "companies": {
78                "type": "list",
79                "data": [
80                    {
81                        "type": "company",
82                        "id": "company_789",
83                        "url": "https://api.intercom.io/companies/company_789"
84                    }
85                ],
86                "url": "https://api.intercom.io/contacts/5f1a2b3c4d5e6f7g8h9i0j/companies",
87                "total_count": 1,
88                "has_more": false
89            }
90        }
91    ],
92    "total_count": 1,
93    "pages": {
94        "type": "pages",
95        "page": 1,
96        "per_page": 50,
97        "total_pages": 1
98    }
99}

Search conversations
Copy

Searches for conversations by the value of their attributes.

Sample Input

1{
2    "access_token": "dG9rZW4=",
3    "query": {
4        "operator": "AND",
5        "value": [
6            {
7                "field": "updated_at",
8                "operator": ">",
9                "value": 1625097600
10            },
11            {
12                "field": "open",
13                "operator": "=",
14                "value": true
15            }
16        ]
17    },
18    "per_page": 50
19}

Sample Output

1{
2    "type": "conversation.list",
3    "pages": {
4        "type": "pages",
5        "page": 1,
6        "per_page": 50,
7        "total_pages": 3
8    },
9    "total_count": 125,
10    "conversations": [
11        {
12            "type": "conversation",
13            "id": "123456789",
14            "created_at": 1625184000,
15            "updated_at": 1625270400,
16            "waiting_since": 1625270400,
17            "snoozed_until": null,
18            "source": {
19                "type": "email",
20                "id": "987654321",
21                "delivered_as": "email",
22                "subject": "Need help with product",
23                "body": "Hi, I'm having trouble with...",
24                "author": {
25                    "type": "user",
26                    "id": "user_123",
27                    "name": "John Doe",
28                    "email": "john.doe@example.com"
29                },
30                "attachments": [],
31                "url": null
32            },
33            "contacts": {
34                "type": "contact.list",
35                "contacts": [
36                    {
37                        "type": "contact",
38                        "id": "contact_123"
39                    }
40                ]
41            },
42            "first_contact_reply": {
43                "created_at": 1625270500,
44                "type": "conversation_part",
45                "url": null
46            },
47            "open": true,
48            "state": "open",
49            "read": false,
50            "tags": {
51                "type": "tag.list",
52                "tags": [
53                    {
54                        "id": "tag_123",
55                        "name": "Support",
56                        "type": "tag"
57                    }
58                ]
59            },
60            "priority": "normal",
61            "sla_applied": null,
62            "statistics": {
63                "type": "conversation_statistics",
64                "time_to_assignment": "1h",
65                "time_to_admin_reply": "2h",
66                "time_to_first_close": null,
67                "time_to_last_close": null,
68                "median_time_to_reply": "30m",
69                "first_contact_reply_at": 1625270500,
70                "first_assignment_at": "1625270700",
71                "first_admin_reply_at": "1625274000",
72                "first_close_at": null,
73                "last_assignment_at": "1625270700",
74                "last_assignment_admin_reply_at": "1625274000",
75                "last_contact_reply_at": 1625270500,
76                "last_admin_reply_at": "1625274000",
77                "last_close_at": null,
78                "last_closed_by_id": null,
79                "count_reopens": 0,
80                "count_assignments": 1,
81                "count_conversation_parts": 2
82            },
83            "conversation_rating": null,
84            "teammates": {
85                "type": "admin.list",
86                "admins": [
87                    {
88                        "type": "admin",
89                        "id": "admin_123"
90                    }
91                ]
92            },
93            "assignee": {
94                "id": "admin_123",
95                "type": "admin",
96                "name": "Support Agent",
97                "email": "support@company.com"
98            }
99        }
100    ]
101}

Submit data event
Copy

Submits a data events.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "contact_id": "5f1a2b3c4d5e6f7g8h9i0j",
4    "event_name": "Product Purchase",
5    "created_at": "2023-06-15T14:30:00Z",
6    "metadata": [
7        {
8            "string": {
9                "key": "product_name",
10                "value": "Premium Widget"
11            }
12        },
13        {
14            "number": {
15                "key": "quantity",
16                "value": 2
17            }
18        },
19        {
20            "date": {
21                "key": "estimated_delivery",
22                "value": "2023-06-20T10:00:00Z"
23            }
24        },
25        {
26            "link": {
27                "key": "product_page",
28                "url": "https://example.com/products/premium-widget"
29            }
30        },
31        {
32            "rich_link": {
33                "key": "order_details",
34                "url": "https://example.com/orders/123456",
35                "value": "View your order details"
36            }
37        },
38        {
39            "monetary_amount": {
40                "key": "total_amount",
41                "amount": 199.99,
42                "currency": "USD"
43            }
44        }
45    ]
46}

Sample Output

1{
2    "success": true
3}

Unarchive contact
Copy

Unarchives a single contact.

Sample Input

1{
2    "access_token": "dG9rZW4xMjM0NTY3ODkwYWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
3    "contact_id": "5f1a2b3c4d5e6f7g8h9i0j"
4}

Sample Output

1{
2    "id": "5f1a2b3c4d5e6f7g8h9i0j",
3    "object": "contact",
4    "archived": false
5}

Update contact
Copy

Updates an existing contact (user or lead).

Sample Input

1{
2    "access_token": "dG9rZW4=",
3    "contact_id": "5f1a2b3c4d5e6f7g8h9i0j",
4    "role": "user",
5    "email": "john.doe@example.com",
6    "name": "John Doe",
7    "phone": "+1234567890",
8    "avatar": "https://example.com/avatar.jpg",
9    "signed_up_at": "2023-06-15T10:30:00Z",
10    "last_seen_at": "2023-06-20T14:45:00Z",
11    "owner_id": 12345,
12    "unsubscribed_from_emails": false,
13    "custom_attributes": [
14        {
15            "key": "company_size",
16            "value": "50-100"
17        },
18        {
19            "key": "industry",
20            "value": "Technology"
21        }
22    ]
23}

Sample Output

1{
2    "type": "contact",
3    "id": "5f1a2b3c4d5e6f7g8h9i0j",
4    "workspace_id": "abc123xyz456",
5    "external_id": "user_123456",
6    "role": "user",
7    "email": "john.doe@example.com",
8    "phone": "+1234567890",
9    "name": "John Doe",
10    "avatar": "https://example.com/avatar.jpg",
11    "owner_id": "12345",
12    "social_profiles": {
13        "type": "list",
14        "data": [
15            {
16                "type": "social_profile",
17                "name": "twitter",
18                "url": "https://twitter.com/johndoe"
19            }
20        ]
21    },
22    "has_hard_bounced": false,
23    "marked_email_as_spam": false,
24    "unsubscribed_from_emails": false,
25    "created_at": 1623758400,
26    "updated_at": 1687276800,
27    "signed_up_at": "2023-06-15T10:30:00Z",
28    "last_seen_at": "2023-06-20T14:45:00Z",
29    "last_replied_at": null,
30    "last_contacted_at": null,
31    "last_email_opened_at": null,
32    "last_email_clicked_at": null,
33    "language_override": null,
34    "browser": "Chrome",
35    "browser_version": "91.0.4472.124",
36    "browser_language": "en-US",
37    "os": "macOS",
38    "location": {
39        "type": "location",
40        "country": "United States",
41        "region": "California",
42        "city": "San Francisco"
43    },
44    "android_app_name": null,
45    "android_app_version": null,
46    "android_device": null,
47    "android_os_version": null,
48    "android_sdk_version": null,
49    "android_last_seen_at": null,
50    "ios_app_name": null,
51    "ios_app_version": null,
52    "ios_device": null,
53    "ios_os_version": null,
54    "ios_sdk_version": null,
55    "ios_last_seen_at": null,
56    "custom_attributes": {
57        "company_size": "50-100",
58        "industry": "Technology"
59    },
60    "tags": {
61        "type": "list",
62        "data": [
63            {
64                "type": "tag",
65                "id": "4567890",
66                "url": "https://api.intercom.io/tags/4567890"
67            }
68        ],
69        "url": "https://api.intercom.io/contacts/5f1a2b3c4d5e6f7g8h9i0j/tags",
70        "total_count": 1,
71        "has_more": false
72    },
73    "notes": {
74        "type": "list",
75        "data": [],
76        "url": "https://api.intercom.io/contacts/5f1a2b3c4d5e6f7g8h9i0j/notes",
77        "total_count": 0,
78        "has_more": false
79    },
80    "companies": {
81        "type": "list",
82        "data": [
83            {
84                "type": "company",
85                "id": "5f1a2b3c4d5e6f7g8h9i0j",
86                "url": "https://api.intercom.io/companies/5f1a2b3c4d5e6f7g8h9i0j"
87            }
88        ],
89        "url": "https://api.intercom.io/contacts/5f1a2b3c4d5e6f7g8h9i0j/companies",
90        "total_count": 1,
91        "has_more": false
92    }
93}