Skip to main content
GET
Retrieve forum
Required permissions:
  • forum:read

Autorisations

Authorization
string
header
requis

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

forum:read

Paramètres de chemin

id
string
requis

The unique identifier of the forum or experience to retrieve.

Réponse

A successful response

A discussion forum where members can create posts, comment, and react, belonging to an experience.

banned_words
string[]
requis

A list of words that are automatically filtered from posts in this forum.

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

banner_image
object | null
requis

The banner image displayed at the top of the forum page. Null if no banner has been uploaded.

email_notification_preference
enum<string>
requis

The email notification setting that controls which posts trigger email alerts. One of: all_admin_posts, only_weekly_summary, none.

Options disponibles:
all_admin_posts,
only_weekly_summary,
none
experience
object
requis

The parent experience that this forum belongs to.

id
string
requis

The unique identifier for the entity

who_can_comment
enum<string>
requis

The permission level controlling who can comment on posts. One of: everyone, admins.

Options disponibles:
everyone,
admins
who_can_post
enum<string>
requis

The permission level controlling who can create new posts. One of: everyone, admins.

Options disponibles:
everyone,
admins