Home
/
REST API Reference
/
Models
/
Social Profile

Intercom API (2.11)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL

https://developers.intercom.com

License

MIT

Languages
Servers
The production API server

https://api.intercom.io/

The european API server

https://api.eu.intercom.io/

The australian API server

https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models

Segments

A list of segments objects attached to a specific contact.

typestringrequired

The type of the object

Value"list"
Example: "list"
dataArray of objects(Segment)required

Segment objects associated with the contact.

data[].​typestringrequired

The type of object.

Value"segment"
Example: "segment"
data[].​idstringrequired

The unique identifier representing the segment.

Example: "56203d253cba154d39010062"
data[].​namestringrequired

The name of the segment.

Example: "Active"
data[].​created_atintegerrequired

The time the segment was created.

Example: 1394621988
data[].​updated_atinteger

The time the segment was updated.

Example: 1394622004
data[].​person_typestringrequired

Type of the contact: contact (lead) or user.

Enum"contact""user"
Example: "contact"
data[].​countinteger or null

The number of items in the user segment. It's returned when include_count=true is included in the request.

Example: 3
{
  "type": "list",
  "data": [
    { … }
  ]
}

Social Profile

An object containing social profiles that a contact has.

dataArray of objects(Social Profile)required

A list of social profiles objects associated with the contact.

data[].​typestringrequired

value is "social_profile"

Example: "social_profile"
data[].​namestringrequired

The name of the Social media profile

Example: "Facebook"
data[].​urlstring(uri)required

The name of the Social media profile

Example: "http://twitter.com/th1sland"
{
  "data": [
    { … }
  ]
}

Contact Subscription Types

An object containing Subscription Types meta data about the SubscriptionTypes that a contact has.

dataArray of objects(Addressable List)required

This object represents the subscriptions attached to a contact.

data[].​typestring(uri)required

The addressable object type

Example: "note"
data[].​idstringrequired

The id of the addressable object

Example: "123"
data[].​urlstring(uri)required

Url to get more company resources for this contact

Example: "/contacts/5ba682d23d7cf92bef87bfd4/notes"
urlstring(uri)required

Url to get more subscription type resources for this contact

Example: "/contacts/5ba682d23d7cf92bef87bfd4/subscriptions"
total_countintegerrequired

Int representing the total number of subscription types attached to this contact

Example: 100
has_morebooleanrequired

Whether there's more Addressable Objects to be viewed. If true, use the url to view all

Example: true
{
  "data": [
    { … }
  ],
  "url": "/contacts/5ba682d23d7cf92bef87bfd4/subscriptions",
  "total_count": 100,
  "has_more": true
}