Skip to main content
Retrieve a feed

Authorizations

Authorization
string
header
required

A Tightknit admin API key, sent as Authorization: Bearer <key>.

Path Parameters

feed_id
string
required

The feed's id.

Pattern: ^feed_[a-zA-Z0-9]{12}$

Query Parameters

expand

Repeatable. Returns the named relation inline. One of: created_by, banner_file, slack_channel.

Available options:
created_by,
banner_file,
slack_channel

Response

Success

object
enum<string>
required

Always feed.

Available options:
feed
id
string
required

Unique identifier for the object.

Example:

"feed_4h2o89z6qlpw"

created_at
string<date-time>
required

When the object was created.

updated_at
string<date-time>
required

When the object was last changed.

label
string
required

The feed’s name, as the community site shows it.

slug
string
required

The feed’s path segment in community site URLs.

Example:

"product-updates"

emoji_icon
string | null
required

The emoji shown beside the feed’s name in the site navigation. Null shows the default icon.

visibility
enum<string>
required

Who may read the feed on the community site. One of:

  • disabled: nobody, the feed is not on the site.
  • public: anyone, including anonymous visitors unless the site requires sign-in.
  • authenticated: any signed-in member.
  • feed_members: only the feed’s own members.
Available options:
disabled,
public,
authenticated,
feed_members
is_archived
boolean
required

Whether the feed is archived.

is_unlisted
boolean
required

Whether the feed is hidden from search engines, sitemaps and feed listings. It stays reachable by direct link.

show_in_navigation_menu
boolean
required

Whether the feed appears in the community site’s navigation menus.

allow_site_posting
boolean
required

Whether signed-in members may create posts and comments in the feed from the community site.

selected_answers_enabled
boolean
required

Whether a thread’s author or an admin may mark replies in the feed as answers.

show_pinned_posts
boolean
required

Whether the feed page shows a carousel of pinned posts above its post list.

list_view_display_format
enum<string>
required

How the feed’s post list is shown on the community site by default. One of:

  • card: a cover image, title, author and date per post.
  • snippet: the start of each post’s body and its attachments.
  • compact: titles and activity stats only.
  • changelog: a timeline grouped by date, each entry with its full body.
Available options:
card,
snippet,
compact,
changelog
post_detail_display_format
enum<string>
required

How a post’s own page is laid out on the community site. One of:

  • discussion: suited to chats, FAQs and threaded discussions.
  • blog: puts the post’s cover image front and center.
Available options:
discussion,
blog
ai_titles_enabled
boolean
required

Whether posts synced to the feed get an AI-generated title, URL slug and description.

ai_post_title_prompt
string | null
required

Admin guidance on how AI-generated post titles should read. Null uses the default voice. Applied only on plans with custom AI prompts.

ai_post_description_prompt
string | null
required

Admin guidance on how the AI-generated search description of each post should read. Null uses the default voice. Applied only on plans with custom AI prompts.

created_by_id
string | null
required

The id of the profile that created the feed. Null when no member created it.

Example:

"prof_5Yq7tVz2Hm3n"

banner_file_id
string | null
required

The id of the image shown at the top of the feed page. Null when the feed has no banner.

Example:

"file_2b3c4d5e6f7g"

integrations
object
required

Where the feed connects to other platforms.

created_by
object | null

The profile that created the feed. Present only when created_by is expanded.

banner_file
object | null

The feed’s banner image. Present only when banner_file is expanded.