Skip to main content
GET
Retrieve experience

Autorisaties

Authorization
string
header
vereist

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

Padparameters

id
string
vereist

The unique identifier of the experience.

Voorbeeld:

"exp_xxxxxxxxxxxxxx"

Respons

A successful response

An experience is a feature or content module within a product, such as a chat, course, or custom app.

app
object
vereist

The app that powers this experience, defining its interface and behavior.

company
object
vereist

The company that owns this experience.

created_at
string<date-time>
vereist

The datetime the experience was created.

Voorbeeld:

"2023-12-01T05:00:00.401Z"

id
string
vereist

The unique identifier for the experience.

Voorbeeld:

"exp_xxxxxxxxxxxxxx"

image
object | null
vereist

The custom logo image for this experience. Null if no custom logo has been uploaded.

is_public
boolean
vereist

Whether this experience is publicly visible to all users, including those without a membership.

name
string
vereist

The display name of this experience shown to users in the product navigation. Maximum 255 characters.

Voorbeeld:

"Trading Signals Chat"

order
string | null
vereist

The sort position of this experience within its section. Lower values appear first. Null if no position has been set.

Voorbeeld:

"123.45"

products
object[]
vereist

The list of products this experience is attached to, which determines which customers have access. Empty if the experience is only visible to authorized company team members.