Skip to content
Home
/
REST API Reference
/
Models
/
Addressable List

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

Activity Log Metadata

Additional data provided about Admin activity.

sign_in_methodstring or null

The way the admin signed in.

Example: "email_password"
external_idstring or null

The unique identifier for the contact which is provided by the Client.

Example: "f3b87a2e09d514c6c2e79b9a"
away_modeboolean or null

The away mode status which is set to true when away and false when returned.

Example: true
away_status_reasonstring or null

The reason the Admin is away.

Example: "😌 On a break"
reassign_conversationsboolean or null

Indicates if conversations should be reassigned while an Admin is away.

Example: false
sourcestring or null

The action that initiated the status change.

Example: "admin update from web - Admin id: 93"
auto_changedstring or null

Indicates if the status was changed automatically or manually.

Example: false
update_byinteger or null

The ID of the Admin who initiated the activity.

Example: 93
update_by_namestring or null

The name of the Admin who initiated the activity.

Example: "Joe Bloggs"
{
  "sign_in_method": "email_password",
  "external_id": "f3b87a2e09d514c6c2e79b9a",
  "away_mode": true,
  "away_status_reason": "😌 On a break",
  "reassign_conversations": false,
  "source": "admin update from web - Admin id: 93",
  "auto_changed": false,
  "update_by": 93,
  "update_by_name": "Joe Bloggs"
}

Addressable List

A list used to access other resources from a parent model.

typestring(uri)required

The addressable object type

Example: "note"
idstringrequired

The id of the addressable object

Example: "123"
urlstring(uri)required

Url to get more company resources for this contact

Example: "/contacts/5ba682d23d7cf92bef87bfd4/notes"
{
  "type": "note",
  "id": "123",
  "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
}

Admins

A list of admins associated with a given workspace.

typestringrequired

String representing the object's type. Always has the value admin.list.

Value"admin.list"
Example: "admin.list"
adminsArray of objects(Admin)required

A list of admins associated with a given workspace.

admins[].​typestring

String representing the object's type. Always has the value admin.

Value"admin"
Example: "admin"
admins[].​idstringrequired

The id representing the admin.

Example: "1295"
admins[].​namestringrequired

The name of the admin.

Example: "Hoban Washburne"
admins[].​emailstringrequired

The email of the admin.

Example: "wash@serenity.io"
admins[].​job_titlestringrequired

The job title of the admin.

Example: "Philosopher"
admins[].​away_mode_enabledbooleanrequired

Identifies if this admin is currently set in away mode.

Example: false
admins[].​away_mode_reassignbooleanrequired

Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.

Example: false
admins[].​has_inbox_seatbooleanrequired

Identifies if this admin has a paid inbox seat to restrict/allow features that require them.

Example: true
admins[].​team_idsArray of integersrequired

This object represents the avatar associated with the admin.

Example: [814865]
admins[].​avatarstring or null(uri)

Image for the associated team or teammate

Example: "https://picsum.photos/200/300"
admins[].​team_priority_levelobject(Team Priority Level)

Admin priority levels for teams

{
  "type": "admin.list",
  "admins": [
    { … }
  ]
}