Retrieve feed

Authorizations

Authorization

string

header

required

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

Path Parameters

feed_id

string<uuid>

required

The ID of the Feed

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Feed details

success

boolean

required

data

object

required

Feed

Show child attributes

data.banner_file_id

string | null

required

Example:

"12345678-90ab-cdef-1234-567890ab"

data.banner_file_url

string | null

required

Example:

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

data.emoji_icon

string | null

required

Example:

":heart:"

data.id

string

required

Example:

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

data.is_archived

boolean

required

Example:

false

data.is_unlisted

boolean

required

Example:

false

data.label

string

required

Example:

"My Feed"

data.list_view_display_format

enum<string>

required

Available options:

card,

snippet,

compact

Example:

"snippet"

data.post_detail_display_format

enum<string>

required

Available options:

discussion,

blog

Example:

"discussion"

data.slack_channel_id

string

required

The ID of the Slack channel synced to the Feed

Example:

"C088TB6CRL4"

data.slack_channel_name

string | null

required

Example:

"general"

data.slack_channel_num_members

number | null

required

Example:

9001

data.slack_channel_purpose_slack_blocks_references

object

required

References to external entities mentioned in the contents of the Slack channel purpose blocks. Note: The channel mentions will not include itself as self-reference.

Show child attributes

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users

object[]

required

The users tagged in the Slack blocks

Show child attributes

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.profile_id

string

required

Example:

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

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.preferred_name

string

required

Example:

"John D."

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_user_id

string | null

Example:

"U088HCYD418"

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_channels

object[]

required

The channels at-mentioned in the Slack blocks

Show child attributes

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_channels.slack_channel

object

required

Slack Channel snippet

Show child attributes

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_channels.slack_channel.id

string

required

Example:

"C088TB6CRL4"

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_channels.slack_channel.name

string | null

required

Example:

"general"

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_channels.feed

object

Feed snippet

Show child attributes

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_channels.feed.id

string

required

Example:

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

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_channels.feed.label

string

required

Example:

"My Feed"

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_channels.feed.slug

string

required

Example:

"my-feed"

data.slack_channel_purpose_slack_blocks_references.custom_emojis

object[]

required

The custom emojis used in the Slack blocks

Show child attributes

data.slack_channel_purpose_slack_blocks_references.custom_emojis.alias

string | null

required

The name of the aliased emoji, if this is an alias

data.slack_channel_purpose_slack_blocks_references.custom_emojis.name

string

required

Example:

"wow"

data.slack_channel_purpose_slack_blocks_references.custom_emojis.url

string | null

required

Example:

"https://example.com/wow.png"

data.slack_channel_purpose_slack_blocks_references.urls

object[]

required

The URLs used in the Slack blocks

Show child attributes

data.slack_channel_purpose_slack_blocks_references.urls.order_seen

number

required

0-indexed order of the URL in the Slack blocks

Example:

0

data.slack_channel_purpose_slack_blocks_references.urls.is_embedded_media

boolean

required

Whether the URL is from media (e.g. image, video) embedded within the Slack blocks, instead of the raw URL appearing directly in text

Example:

false

data.slack_channel_purpose_slack_blocks_references.urls.is_image

boolean

required

Whether the URL refers to an image

Example:

true

data.slack_channel_purpose_slack_blocks_references.urls.is_video

boolean

required

Whether the URL refers to a video

Example:

false

data.slack_channel_purpose_slack_blocks_references.urls.url

string

required

Example:

"https://example.com/tacos.png"

data.slack_channel_topic_slack_blocks_references

object

required

References to external entities mentioned in the contents of the Slack channel topic blocks. Note: The channel mentions will not include itself as self-reference.

Show child attributes

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users

object[]

required

The users tagged in the Slack blocks

Show child attributes

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users.profile_id

string

required

Example:

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

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users.preferred_name

string

required

Example:

"John D."

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_user_id

string | null

Example:

"U088HCYD418"

data.slack_channel_topic_slack_blocks_references.mentioned_slack_channels

object[]

required

The channels at-mentioned in the Slack blocks

Show child attributes

data.slack_channel_topic_slack_blocks_references.mentioned_slack_channels.slack_channel

object

required

Slack Channel snippet

Show child attributes

data.slack_channel_topic_slack_blocks_references.mentioned_slack_channels.slack_channel.id

string

required

Example:

"C088TB6CRL4"

data.slack_channel_topic_slack_blocks_references.mentioned_slack_channels.slack_channel.name

string | null

required

Example:

"general"

data.slack_channel_topic_slack_blocks_references.mentioned_slack_channels.feed

object

Feed snippet

Show child attributes

data.slack_channel_topic_slack_blocks_references.mentioned_slack_channels.feed.id

string

required

Example:

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

data.slack_channel_topic_slack_blocks_references.mentioned_slack_channels.feed.label

string

required

Example:

"My Feed"

data.slack_channel_topic_slack_blocks_references.mentioned_slack_channels.feed.slug

string

required

Example:

"my-feed"

data.slack_channel_topic_slack_blocks_references.custom_emojis

object[]

required

The custom emojis used in the Slack blocks

Show child attributes

data.slack_channel_topic_slack_blocks_references.custom_emojis.alias

string | null

required

The name of the aliased emoji, if this is an alias

data.slack_channel_topic_slack_blocks_references.custom_emojis.name

string

required

Example:

"wow"

data.slack_channel_topic_slack_blocks_references.custom_emojis.url

string | null

required

Example:

"https://example.com/wow.png"

data.slack_channel_topic_slack_blocks_references.urls

object[]

required

The URLs used in the Slack blocks

Show child attributes

data.slack_channel_topic_slack_blocks_references.urls.order_seen

number

required

0-indexed order of the URL in the Slack blocks

Example:

0

data.slack_channel_topic_slack_blocks_references.urls.is_embedded_media

boolean

required

Whether the URL is from media (e.g. image, video) embedded within the Slack blocks, instead of the raw URL appearing directly in text

Example:

false

data.slack_channel_topic_slack_blocks_references.urls.is_image

boolean

required

Whether the URL refers to an image

Example:

true

data.slack_channel_topic_slack_blocks_references.urls.is_video

boolean

required

Whether the URL refers to a video

Example:

false

data.slack_channel_topic_slack_blocks_references.urls.url

string

required

Example:

"https://example.com/tacos.png"

data.slug

string

required

Example:

"my-feed"

Example:

true

data.is_site_posting_enabled

boolean

required

Whether members can create posts for this Feed from the Companion Site

Example:

true

data.slack_channel_purpose_slack_blocks

object[] | null

The Slack channel description in Slack blocks format for rich text input element.

Show child attributes

data.slack_channel_purpose_slack_blocks.type

enum<string>

required

Available options:

rich_text

data.slack_channel_purpose_slack_blocks.elements

object[]

required

Option 1
Option 2
Option 3
Option 4

Show child attributes

data.slack_channel_purpose_slack_blocks.elements.type

enum<string>

required

Available options:

rich_text_section

data.slack_channel_purpose_slack_blocks.elements.elements

object[]

required

Show child attributes

data.slack_channel_purpose_slack_blocks.elements.elements.type

enum<string>

required

Available options:

broadcast

data.slack_channel_purpose_slack_blocks.elements.elements.range

enum<string>

required

Available options:

here,

channel,

everyone

data.slack_channel_purpose_slack_blocks.block_id

string

Example:

[
  {
    "type": "rich_text",
    "elements": [
      {
        "type": "rich_text_section",
        "elements": [
          {
            "text": "This is the Slack channel description.",
            "type": "text"
          }
        ]
      }
    ]
  }
]

data.slack_channel_topic_slack_blocks

object[] | null

The Slack channel topic in Slack blocks format for rich text input element

Show child attributes

data.slack_channel_topic_slack_blocks.type

enum<string>

required

Available options:

rich_text

data.slack_channel_topic_slack_blocks.elements

object[]

required

Option 1
Option 2
Option 3
Option 4

Show child attributes

data.slack_channel_topic_slack_blocks.elements.type

enum<string>

required

Available options:

rich_text_section

data.slack_channel_topic_slack_blocks.elements.elements

object[]

required

Show child attributes

data.slack_channel_topic_slack_blocks.elements.elements.type

enum<string>

required

Available options:

broadcast

data.slack_channel_topic_slack_blocks.elements.elements.range

enum<string>

required

Available options:

here,

channel,

everyone

data.slack_channel_topic_slack_blocks.block_id

string

Example:

[
  {
    "type": "rich_text",
    "elements": [
      {
        "type": "rich_text_section",
        "elements": [
          {
            "text": "This is the Slack channel topic.",
            "type": "text"
          }
        ]
      }
    ]
  }
]

Overview

Admin API

Authorizations

Path Parameters

Response