Get posts of a Feed

GET

admin

feeds

{feed_id}

posts

{
  "success": true,
  "data": {
    "page": 0,
    "per_page": 10,
    "count": 10,
    "total_records": 100,
    "total_pages": 10,
    "has_next": true,
    "records": [
      {
        "id": "w6sy87nsu78w",
        "created_at": "2024-02-01 04:04:39.198523+00",
        "title": "My Post",
        "slug": "my-post",
        "feed_id": "91795199-9d00-47c7-bd6e-d4049bb63451",
        "author_profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
        "read_time_minutes": 5,
        "file_attachments_count": 1,
        "reactions_count": 10,
        "comments_count": 2,
        "slack_message": {
          "id": "1519c63a-f8cf-4897-a76e-ef556d5fd915",
          "message_ts": 1737338258.891569,
          "blocks": [
            {
              "type": "rich_text",
              "elements": [
                {
                  "type": "rich_text_section",
                  "elements": [
                    {
                      "text": "Hello, world!",
                      "type": "text"
                    }
                  ]
                }
              ]
            }
          ],
          "markdown": "This is the message mrkdwn text.",
          "permalink": "https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ",
          "parent_slack_message_id": "97d5c5d6-d036-4223-9bd3-876a0cf47751"
        },
        "cover_image_url": "https://example.com/my-image.png",
        "author": {
          "profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
          "created_at": "2024-02-01 04:04:39.198523+00",
          "preferred_name": "John D.",
          "first_name": "John",
          "last_name": "Doe",
          "email": "[email protected]",
          "slack_user_id": "U088HCYD418",
          "slack_is_admin": false,
          "slack_is_bot": false,
          "slack_first_name": "John",
          "slack_last_name": "Doe",
          "slack_image_72": "https://example.com/image72.png",
          "slack_image_original": "https://example.com/image.png"
        },
        "feed": {
          "id": "91795199-9d00-47c7-bd6e-d4049bb63451",
          "label": "My Feed",
          "slug": "my-feed"
        },
        "references": {
          "mentioned_slack_users": [
            {
              "profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
              "created_at": "2024-02-01 04:04:39.198523+00",
              "preferred_name": "John D.",
              "first_name": "John",
              "last_name": "Doe",
              "email": "[email protected]",
              "slack_user_id": "U088HCYD418",
              "slack_is_admin": false,
              "slack_is_bot": false,
              "slack_first_name": "John",
              "slack_last_name": "Doe",
              "slack_image_72": "https://example.com/image72.png",
              "slack_image_original": "https://example.com/image.png"
            }
          ],
          "mentioned_slack_channels": [
            {
              "slack_channel": {
                "id": "C088TB6CRL4",
                "name": "general"
              },
              "feed": {
                "id": "91795199-9d00-47c7-bd6e-d4049bb63451",
                "label": "My Feed",
                "slug": "my-feed"
              }
            }
          ],
          "custom_emojis": [
            {
              "alias": "<string>",
              "name": "wow",
              "url": "https://example.com/wow.png"
            }
          ],
          "urls": [
            {
              "order_seen": 0,
              "is_embedded_media": false,
              "is_image": true,
              "is_video": false,
              "url": "https://example.com/tacos.png"
            }
          ]
        }
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

feed_id

required

The ID of the Feed, or the string "home" for the Home feed.

Example:

"home"

Query Parameters

page

integer

The page number (0-indexed)

Example:

0

per_page

integer

The number of records per page

Example:

10

sort

enum<string>

default:newest

Sort the posts by the specified method. If no sort specified, posts are sorted by newest first.

Available options:

oldest,

newest,

most-recent-activity

Example:

"newest"

Response

200

application/json

Gets a list of Posts in the Feed

success

boolean

required

data

object

required

data.page

number

required

The current page number (0-indexed)

Required range: x >= 0

Example:

0

data.per_page

number

required

The number of records per page

Required range: 1 <= x <= 20

Example:

10

data.count

number

required

The number of records in the current page

Required range: x >= 0

Example:

10

data.total_records

number

required

The total number of records

Required range: x >= 0

Example:

100

data.total_pages

number

required

The total number of pages

Example:

10

data.has_next

boolean

required

Whether there is a next page of additional records after the current page

Example:

true

data.records

object[]

required

The list of records in the current page

Post

data.records.id

string

required

Example:

"w6sy87nsu78w"

data.records.created_at

string

required

Example:

"2024-02-01 04:04:39.198523+00"

data.records.title

string

required

Example:

"My Post"

data.records.slug

string

required

Example:

"my-post"

data.records.feed_id

string

required

Example:

"91795199-9d00-47c7-bd6e-d4049bb63451"

data.records.author_profile_id

string

required

Example:

"03ff107d-099f-4426-81a6-a04690d7afz3"

data.records.read_time_minutes

number

required

The estimated time to read the post in minutes

Example:

5

data.records.file_attachments_count

number

required

Example:

1

data.records.reactions_count

number

required

Example:

10

data.records.comments_count

number

required

Example:

2

data.records.slack_message

object

required

Slack Message

data.records.slack_message.id

string

required

Example:

"1519c63a-f8cf-4897-a76e-ef556d5fd915"

data.records.slack_message.message_ts

number

required

The Slack message timestamp

Example:

1737338258.891569

data.records.slack_message.blocks

object[]

required

The message in Slack blocks format for rich text input element.

Example:

[
  {
    "type": "rich_text",
    "elements": [
      {
        "type": "rich_text_section",
        "elements": [{ "text": "Hello, world!", "type": "text" }]
      }
    ]
  }
]

data.records.slack_message.markdown

string

required

The Slack message content in mrkdwn format

Example:

"This is the message mrkdwn text."

data.records.slack_message.permalink

string | null

required

The URL permalink to the Slack message

Example:

"https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ"

data.records.slack_message.parent_slack_message_id

string | null

The ID of the top-most parent Slack message, if this is a threaded reply

Example:

"97d5c5d6-d036-4223-9bd3-876a0cf47751"

data.records.author

object

required

data.records.feed

object

required

Feed summary

data.records.references

object

required

References to external entities mentioned in the contents of the Slack blocks

data.records.references.mentioned_slack_users

object[]

required

The users tagged in the Slack blocks

data.records.references.mentioned_slack_channels

object[]

required

The channels at-mentioned in the Slack blocks

data.records.references.custom_emojis

object[]

required

The custom emojis used in the Slack blocks

Slack Custom Emoji usage

data.records.references.urls

object[]

required

The URLs used in the Slack blocks

Slack Blocks URL usage

data.records.cover_image_url

string | null

The URL of the cover image for the post

Example:

"https://example.com/my-image.png"

Was this page helpful?

Get a Feed Upload a public file

{
  "success": true,
  "data": {
    "page": 0,
    "per_page": 10,
    "count": 10,
    "total_records": 100,
    "total_pages": 10,
    "has_next": true,
    "records": [
      {
        "id": "w6sy87nsu78w",
        "created_at": "2024-02-01 04:04:39.198523+00",
        "title": "My Post",
        "slug": "my-post",
        "feed_id": "91795199-9d00-47c7-bd6e-d4049bb63451",
        "author_profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
        "read_time_minutes": 5,
        "file_attachments_count": 1,
        "reactions_count": 10,
        "comments_count": 2,
        "slack_message": {
          "id": "1519c63a-f8cf-4897-a76e-ef556d5fd915",
          "message_ts": 1737338258.891569,
          "blocks": [
            {
              "type": "rich_text",
              "elements": [
                {
                  "type": "rich_text_section",
                  "elements": [
                    {
                      "text": "Hello, world!",
                      "type": "text"
                    }
                  ]
                }
              ]
            }
          ],
          "markdown": "This is the message mrkdwn text.",
          "permalink": "https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ",
          "parent_slack_message_id": "97d5c5d6-d036-4223-9bd3-876a0cf47751"
        },
        "cover_image_url": "https://example.com/my-image.png",
        "author": {
          "profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
          "created_at": "2024-02-01 04:04:39.198523+00",
          "preferred_name": "John D.",
          "first_name": "John",
          "last_name": "Doe",
          "email": "[email protected]",
          "slack_user_id": "U088HCYD418",
          "slack_is_admin": false,
          "slack_is_bot": false,
          "slack_first_name": "John",
          "slack_last_name": "Doe",
          "slack_image_72": "https://example.com/image72.png",
          "slack_image_original": "https://example.com/image.png"
        },
        "feed": {
          "id": "91795199-9d00-47c7-bd6e-d4049bb63451",
          "label": "My Feed",
          "slug": "my-feed"
        },
        "references": {
          "mentioned_slack_users": [
            {
              "profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
              "created_at": "2024-02-01 04:04:39.198523+00",
              "preferred_name": "John D.",
              "first_name": "John",
              "last_name": "Doe",
              "email": "[email protected]",
              "slack_user_id": "U088HCYD418",
              "slack_is_admin": false,
              "slack_is_bot": false,
              "slack_first_name": "John",
              "slack_last_name": "Doe",
              "slack_image_72": "https://example.com/image72.png",
              "slack_image_original": "https://example.com/image.png"
            }
          ],
          "mentioned_slack_channels": [
            {
              "slack_channel": {
                "id": "C088TB6CRL4",
                "name": "general"
              },
              "feed": {
                "id": "91795199-9d00-47c7-bd6e-d4049bb63451",
                "label": "My Feed",
                "slug": "my-feed"
              }
            }
          ],
          "custom_emojis": [
            {
              "alias": "<string>",
              "name": "wow",
              "url": "https://example.com/wow.png"
            }
          ],
          "urls": [
            {
              "order_seen": 0,
              "is_embedded_media": false,
              "is_image": true,
              "is_video": false,
              "url": "https://example.com/tacos.png"
            }
          ]
        }
      }
    ]
  }
}

Award

Badge

Feeds

Files

Groups

Calendar Events

Search

Webhooks

Get posts of a Feed

Authorizations

Path Parameters

Query Parameters

Response