Feeds
Get a list of Feeds in the community
Feeds
Get a list of Feeds in the community
Gets a list of Feeds in the community.
GET
/
admin
/
v0
/
feeds
{
"success": true,
"data": {
"page": 0,
"per_page": 10,
"count": 10,
"total_records": 100,
"total_pages": 10,
"has_next": true,
"records": [
{
"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"
}
],
"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"
}
],
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The page number (0-indexed)
Example:
0
The number of records per page
Example:
10
Response
200
application/json
Gets a list of Feeds in the community
The current page number (0-indexed)
Required range:
x >= 0Example:
0
The number of records per page
Required range:
1 <= x <= 20Example:
10
The number of records in the current page
Required range:
x >= 0Example:
10
The total number of records
Required range:
x >= 0Example:
100
The total number of pages
Example:
10
Whether there is a next page of additional records after the current page
Example:
true
The list of records in the current page
Feed
Example:
"12345678-90ab-cdef-1234-567890ab"
Example:
"https://example.com/my-banner.png"
Example:
":heart:"
Example:
"91795199-9d00-47c7-bd6e-d4049bb63451"
Example:
false
Example:
"My Feed"
Available options:
card, snippet, compact Example:
"snippet"
Available options:
discussion, blog Example:
"discussion"
The ID of the Slack channel synced to the Feed
Example:
"C088TB6CRL4"
Example:
9001
References to external entities mentioned in the contents of the Slack blocks
The users tagged in the Slack blocks
data.records.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.profile_id
string
required
Example:
"03ff107d-099f-4426-81a6-a04690d7afz3"
data.records.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.created_at
string
required
Example:
"2024-02-01 04:04:39.198523+00"
data.records.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.preferred_name
string
required
Example:
"John D."
data.records.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.first_name
string | null
required
Example:
"John"
data.records.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.last_name
string | null
required
Example:
"Doe"
data.records.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_user_id
string
required
Example:
"U088HCYD418"
data.records.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_is_admin
boolean
required
Example:
false
data.records.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_is_bot
boolean
required
Example:
false
data.records.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_first_name
string | null
required
Example:
"John"
data.records.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_last_name
string | null
required
Example:
"Doe"
data.records.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_image_72
string | null
required
Example:
"https://example.com/image72.png"
data.records.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.slack_image_original
string | null
required
Example:
"https://example.com/image.png"
data.records.slack_channel_purpose_slack_blocks_references.mentioned_slack_users.email
string | null
Example:
data.records.slack_channel_purpose_slack_blocks_references.mentioned_slack_channels
object[]
required
The custom emojis used in the Slack blocks
Slack Custom Emoji usage
data.records.slack_channel_purpose_slack_blocks_references.custom_emojis.alias
string | null
required
The name of the aliased emoji, if this is an alias
Example:
"wow"
Example:
"https://example.com/wow.png"
The URLs used in the Slack blocks
Slack Blocks URL usage
0-indexed order of the URL in the Slack blocks
Example:
0
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
Whether the URL refers to an image
Example:
true
Whether the URL refers to a video
Example:
false
Example:
"https://example.com/tacos.png"
References to external entities mentioned in the contents of the Slack blocks
The users tagged in the Slack blocks
data.records.slack_channel_topic_slack_blocks_references.mentioned_slack_users.profile_id
string
required
Example:
"03ff107d-099f-4426-81a6-a04690d7afz3"
data.records.slack_channel_topic_slack_blocks_references.mentioned_slack_users.created_at
string
required
Example:
"2024-02-01 04:04:39.198523+00"
data.records.slack_channel_topic_slack_blocks_references.mentioned_slack_users.preferred_name
string
required
Example:
"John D."
data.records.slack_channel_topic_slack_blocks_references.mentioned_slack_users.first_name
string | null
required
Example:
"John"
data.records.slack_channel_topic_slack_blocks_references.mentioned_slack_users.last_name
string | null
required
Example:
"Doe"
data.records.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_user_id
string
required
Example:
"U088HCYD418"
data.records.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_is_admin
boolean
required
Example:
false
data.records.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_is_bot
boolean
required
Example:
false
data.records.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_first_name
string | null
required
Example:
"John"
data.records.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_last_name
string | null
required
Example:
"Doe"
data.records.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_image_72
string | null
required
Example:
"https://example.com/image72.png"
data.records.slack_channel_topic_slack_blocks_references.mentioned_slack_users.slack_image_original
string | null
required
Example:
"https://example.com/image.png"
Example:
The custom emojis used in the Slack blocks
Slack Custom Emoji usage
The name of the aliased emoji, if this is an alias
Example:
"wow"
Example:
"https://example.com/wow.png"
The URLs used in the Slack blocks
Slack Blocks URL usage
0-indexed order of the URL in the Slack blocks
Example:
0
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
Whether the URL refers to an image
Example:
true
Whether the URL refers to a video
Example:
false
Example:
"https://example.com/tacos.png"
Example:
"my-feed"
Example:
true
The message in Slack blocks format for rich text input element.
Available options:
rich_text Example:
[
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"text": "This is the Slack channel description.",
"type": "text"
}
]
}
]
}
]
The message in Slack blocks format for rich text input element.
Available options:
rich_text Example:
[
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"text": "This is the Slack channel topic.",
"type": "text"
}
]
}
]
}
]
Was this page helpful?
{
"success": true,
"data": {
"page": 0,
"per_page": 10,
"count": 10,
"total_records": 100,
"total_pages": 10,
"has_next": true,
"records": [
{
"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"
}
],
"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"
}
],
"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
}
]
}
}