Pagination Object

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

typestringrequired

Value"pages"

Example: "pages"

pageintegerrequired

Example: 1

nextstring or null(uri)

A link to the next page of results. A response that does not contain a next link does not have further data to fetch.

per_pageintegerrequired

Example: 50

total_pagesintegerrequired

Example: 1

{
  "type": "pages",
  "page": 1,
  "next": "http://example.com",
  "per_page": 50,
  "total_pages": 1
}

Paginated News Item Response

typestringrequired

The type of object

Value"list"

Example: "list"

pagesobject(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.

total_countintegerrequired

A count of the total number of News Items.

Example: 1

dataArray of objects(News Item)required

An array of News Items

data[].typestringrequired

The type of object.

Value"news-item"

Example: "news-item"

data[].idstringrequired

The unique identifier for the news item which is given by Intercom.

Example: "141"

data[].workspace_idstringrequired

The id of the workspace which the news item belongs to.

Example: "t74hdn32"

data[].titlestringrequired

The title of the news item.

Example: "New feature: News Items"

data[].bodystringrequired

The news item body, which may contain HTML.

Example: "We are excited to announce the launch of News Items, a new content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers."

data[].sender_idintegerrequired

The id of the sender of the news item. Must be a teammate on the workspace.

Example: 123

data[].statestringrequired

News items will not be visible to your users in the assigned newsfeeds until they are set live.

Enum"draft""live"

Example: "live"

data[].newsfeed_assignmentsArray of objects(Newsfeed Assignment)

A list of newsfeed_assignments to assign to the specified newsfeed.

data[].labelsArray of strings or null

Label names displayed to users to categorize the news item.

Example: ["Product Update"]

data[].cover_image_urlstring or null(uri)

URL of the image used as cover. Must have .jpg or .png extension.

Example: "https://example.com/cover.jpg"

data[].reactionsArray of strings or null

Ordered list of emoji reactions to the news item. When empty, reactions are disabled.

Example: ["👍"]

data[].deliver_silentlyboolean

When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.

Example: true

data[].created_atinteger(timestamp)required

Timestamp for when the news item was created.

Example: 1610589632

data[].updated_atinteger(timestamp)

Timestamp for when the news item was last updated.

Example: 1610589632

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

Intercom API (2.11)

Admins

Articles

Companies

Contacts

Conversations

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Segments

Subscription Types

Switch

Tags

Teams

Ticket Type Attributes

Ticket Types

Tickets

Visitors

Models

Open Conversation Request

Pagination Object

Paginated News Item Response