Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The unique identifier of the forum or experience to retrieve.

Response

A successful response

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

email_notification_preference
enum<string>
required

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

Available options:
all_admin_posts,
only_weekly_summary,
none
experience
object
required

The parent experience that this forum belongs to.

id
string
required

The unique identifier for the entity

who_can_comment
enum<string>
required

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

Available options:
everyone,
admins
who_can_post
enum<string>
required

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

Available options:
everyone,
admins