Skip to content
Home
/
REST API Reference
/
Models
/
Contact Location

Intercom API (2.10)

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

Contact List

Contacts are your users in Intercom.

typestring

Always list

Value"list"
Example: "list"
dataArray of objects(Contact)

The list of contact objects

total_countinteger

A count of the total number of objects.

Example: 100
pagesobject or null(Cursor based pages)

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

{
  "type": "list",
  "data": [
    { … }
  ],
  "total_count": 100,
  "pages": {
    "type": "pages",
    "page": 1,
    "next": { … },
    "per_page": 2,
    "total_pages": 13
  }
}

Contact Location

An object containing location meta data about a Intercom contact.

typestring or null

Always location

Example: "location"
countrystring or null

The country that the contact is located in

Example: "Ireland"
regionstring or null

The overal region that the contact is located in

Example: "Dublin"
citystring or null

The city that the contact is located in

Example: "Dublin"
{
  "type": "location",
  "country": "Ireland",
  "region": "Dublin",
  "city": "Dublin"
}

Contact notes

An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.

dataArray of objects(Addressable List)

This object represents the notes attached to a contact.

urlstring(uri)

Url to get more company resources for this contact

Example: "/contacts/5ba682d23d7cf92bef87bfd4/notes"
total_countinteger

Int representing the total number of companyies attached to this contact

Example: 100
has_moreboolean

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

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