Home
/
REST API Reference
/
Models
/
Paginated Newsfeed Response

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

Paginated News Item Response

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": [
    { … }
  ]
}

Paginated Newsfeed Response

Paginated Newsfeed 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 Newsfeeds.

Example: 1
dataArray of objects(Newsfeed)required

An array of Newsfeeds

data[].​idstringrequired

The unique identifier for the newsfeed which is given by Intercom.

Example: "12312"
data[].​typestringrequired

The type of object.

Value"newsfeed"
Example: "newsfeed"
data[].​namestringrequired

The name of the newsfeed. This name will never be visible to your users.

Example: "My Newsfeed"
data[].​created_atinteger(timestamp)required

Timestamp for when the newsfeed was created.

Example: 1674917488
data[].​updated_atinteger(timestamp)

Timestamp for when the newsfeed was last updated.

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

Part attachment

The file attached to a part

typestringrequired

The type of attachment

Example: "upload"
namestringrequired

The name of the attachment

Example: "example.png"
urlstringrequired

The URL of the attachment

Example: "https://picsum.photos/200/300"
content_typestringrequired

The content type of the attachment

Example: "image/png"
filesizeintegerrequired

The size of the attachment

Example: 100
widthintegerrequired

The width of the attachment

Example: 100
heightintegerrequired

The height of the attachment

Example: 100
{
  "type": "upload",
  "name": "example.png",
  "url": "https://picsum.photos/200/300",
  "content_type": "image/png",
  "filesize": 100,
  "width": 100,
  "height": 100
}