Skip to main content
GET
List blocks for 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
block_type
enum<string>
required
Available options:
text,
image,
video,
document,
embed,
introduction,
action_bar,
banner,
lead_deal_analytics,
goals,
link,
advanced_search,
files,
pricing_calculator,
partner_details,
form,
secure_files
label
string | null
required
series
number
required

Display order (1-indexed)

content
any
required

Block content — shape varies by block_type. See documentation.

block_settings
object
required

Block-type-specific settings, as returned by the API. Same shape as the request except action_bar button target uuids (resource_uuid/folder_uuid/certification_uuid/room_uuid) tolerate null when the stored target no longer resolves for the caller's company.

asset_uuid
string | null
required

Associated asset (image, video file, document, etc.)

contact_tag_uuids
string[]
required

Contact tags allowed to see this block. With none, every contact who can see the room sees the block. With one or more, only contacts that carry at least one of these tags see it. An empty list means the block has no tag restriction.

created_at
string
required
updated_at
string
required