Get a Feed

GET

admin

feeds

{feed_id}

{
  "success": true,
  "data": {
    "banner_file_id": "12345678-90ab-cdef-1234-567890ab",
    "banner_file_url": "https://example.com/my-banner.png",
    "emoji_icon": ":heart:",
    "id": "91795199-9d00-47c7-bd6e-d4049bb63451",
    "is_unlisted": false,
    "label": "My Feed",
    "list_view_display_format": "snippet",
    "post_detail_display_format": "discussion",
    "slack_channel_id": "C088TB6CRL4",
    "slack_channel_num_members": 9001,
    "slack_channel_purpose_slack_blocks": [
      {
        "type": "rich_text",
        "elements": [
          {
            "type": "rich_text_section",
            "elements": [
              {
                "text": "This is the Slack channel description.",
                "type": "text"
              }
            ]
          }
        ]
      }
    ],
    "slack_channel_purpose_slack_blocks_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",
          "slack_profile": {
            "deprecated": true,
            "warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
            "id": "U088HCYD418",
            "is_admin": false,
            "is_bot": false,
            "first_name": "John",
            "last_name": "Doe",
            "email": "[email protected]",
            "image_72": "https://example.com/image72.png",
            "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"
        }
      ]
    },
    "slack_channel_topic_slack_blocks": [
      {
        "type": "rich_text",
        "elements": [
          {
            "type": "rich_text_section",
            "elements": [
              {
                "text": "This is the Slack channel topic.",
                "type": "text"
              }
            ]
          }
        ]
      }
    ],
    "slack_channel_topic_slack_blocks_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",
          "slack_profile": {
            "deprecated": true,
            "warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
            "id": "U088HCYD418",
            "is_admin": false,
            "is_bot": false,
            "first_name": "John",
            "last_name": "Doe",
            "email": "[email protected]",
            "image_72": "https://example.com/image72.png",
            "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"
        }
      ]
    },
    "slug": "my-feed",
    "show_in_navigation_menu": true
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

feed_id

string

required

The ID of the Feed

Example:

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

Response

200

application/json

Gets a Feed

success

boolean

required

data

object

required

Feed

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_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_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 blocks

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users

object[]

required

The users tagged in the Slack blocks

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.created_at

string

required

Example:

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

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.first_name

string | null

required

Example:

"John"

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.last_name

string | null

required

Example:

"Doe"

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_user_id

string

required

Example:

"U088HCYD418"

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_is_admin

boolean

required

Example:

false

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_is_bot

boolean

required

Example:

false

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_first_name

string | null

required

Example:

"John"

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_last_name

string | null

required

Example:

"Doe"

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_image_72

string | null

required

Example:

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

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_image_original

string | null

required

Example:

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

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_profile

object

required

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.email

string | null

Example:

"[email protected]"

data.slack_channel_purpose_slack_blocks_references.mentioned_slack_channels

object[]

required

The channels at-mentioned in the Slack blocks

data.slack_channel_purpose_slack_blocks_references.custom_emojis

object[]

required

The custom emojis used in the Slack blocks

Slack Custom Emoji usage

data.slack_channel_purpose_slack_blocks_references.urls

object[]

required

The URLs used in the Slack blocks

Slack Blocks URL usage

data.slack_channel_topic_slack_blocks_references

object

required

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

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users

object[]

required

The users tagged in the Slack blocks

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.created_at

string

required

Example:

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

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.first_name

string | null

required

Example:

"John"

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users.last_name

string | null

required

Example:

"Doe"

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_user_id

string

required

Example:

"U088HCYD418"

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_is_admin

boolean

required

Example:

false

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_is_bot

boolean

required

Example:

false

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_first_name

string | null

required

Example:

"John"

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_last_name

string | null

required

Example:

"Doe"

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_image_72

string | null

required

Example:

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

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_image_original

string | null

required

Example:

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

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_profile

object

required

data.slack_channel_topic_slack_blocks_references.mentioned_slack_users.email

string | null

Example:

"[email protected]"

data.slack_channel_topic_slack_blocks_references.mentioned_slack_channels

object[]

required

The channels at-mentioned in the Slack blocks

data.slack_channel_topic_slack_blocks_references.custom_emojis

object[]

required

The custom emojis used in the Slack blocks

Slack Custom Emoji usage

data.slack_channel_topic_slack_blocks_references.urls

object[]

required

The URLs used in the Slack blocks

Slack Blocks URL usage

data.slug

string

required

Example:

"my-feed"

Example:

true

data.slack_channel_purpose_slack_blocks

object[] | null

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

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 message in Slack blocks format for rich text input element.

Example:

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

Was this page helpful?

Get a list of Feeds in the community Get posts of a Feed

{
  "success": true,
  "data": {
    "banner_file_id": "12345678-90ab-cdef-1234-567890ab",
    "banner_file_url": "https://example.com/my-banner.png",
    "emoji_icon": ":heart:",
    "id": "91795199-9d00-47c7-bd6e-d4049bb63451",
    "is_unlisted": false,
    "label": "My Feed",
    "list_view_display_format": "snippet",
    "post_detail_display_format": "discussion",
    "slack_channel_id": "C088TB6CRL4",
    "slack_channel_num_members": 9001,
    "slack_channel_purpose_slack_blocks": [
      {
        "type": "rich_text",
        "elements": [
          {
            "type": "rich_text_section",
            "elements": [
              {
                "text": "This is the Slack channel description.",
                "type": "text"
              }
            ]
          }
        ]
      }
    ],
    "slack_channel_purpose_slack_blocks_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",
          "slack_profile": {
            "deprecated": true,
            "warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
            "id": "U088HCYD418",
            "is_admin": false,
            "is_bot": false,
            "first_name": "John",
            "last_name": "Doe",
            "email": "[email protected]",
            "image_72": "https://example.com/image72.png",
            "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"
        }
      ]
    },
    "slack_channel_topic_slack_blocks": [
      {
        "type": "rich_text",
        "elements": [
          {
            "type": "rich_text_section",
            "elements": [
              {
                "text": "This is the Slack channel topic.",
                "type": "text"
              }
            ]
          }
        ]
      }
    ],
    "slack_channel_topic_slack_blocks_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",
          "slack_profile": {
            "deprecated": true,
            "warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
            "id": "U088HCYD418",
            "is_admin": false,
            "is_bot": false,
            "first_name": "John",
            "last_name": "Doe",
            "email": "[email protected]",
            "image_72": "https://example.com/image72.png",
            "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"
        }
      ]
    },
    "slug": "my-feed",
    "show_in_navigation_menu": true
  }
}

Badge

Feeds

Files

Groups

Calendar Events

Search

Webhooks

Authorizations

Path Parameters

Response