Skip to main content
GET
Get a room

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

200 - application/json

Default Response

uuid
string
required
label
string | null
required
room_type
enum<string>
required
Available options:
overview,
distributor_partners,
leads,
deals,
payments,
resources,
certifications,
projects,
contacts,
messages,
brand_guidelines,
shared_files,
private_files,
mdf,
campaigns,
custom
live
boolean
required
partner_type
enum<string>
required
Available options:
referral,
reseller,
distributor
series
number
required
room_visibility
enum<string>
required
Available options:
all,
internal_only,
external_only
internal_label
string | null
required
viewable_by_distributors
boolean
required
created_at
string
required
updated_at
string
required
tiers
object[]
required
categories
object[]
required
stages
object[]
required
tags
object[]
required
partnerships
object[]
required

Partnerships granted explicit access to the room, including grants whose expiry has passed, ordered by name. Archived partnerships are omitted and at most 500 are listed. The room is restricted to specific partnerships while it has any grant, expired or not; once its last grant is removed it is visible to every partnership of its partner type.

blocks
object[]
required
room_settings
object
required

Room-level configuration.