Skip to main content
GET
/
rooms
/
{uuid}
/
blocks
List blocks for a room
curl --request GET \
  --url https://api.journeybee.io/v1/rooms/{uuid}/blocks \
  --header 'Authorization: Bearer <token>'
[
  {
    "uuid": "<string>",
    "label": "<string>",
    "series": 123,
    "content": "<unknown>",
    "block_settings": {
      "display": {
        "height": 123,
        "fullScreen": true,
        "showExternalLink": true
      },
      "action_bar": {
        "buttons": [
          {
            "label": "<string>",
            "icon": "<string>",
            "url": "<string>",
            "background_color": "<string>",
            "text_color": "<string>",
            "icon_color": "<string>",
            "room_uuid": "<string>",
            "series": 500
          }
        ]
      },
      "goals": {
        "showProgress": true,
        "showCountdown": true,
        "allowResourceLinks": true
      },
      "advanced_search": {
        "title": "<string>",
        "placeholder": "<string>",
        "showAITab": true,
        "showQuickActions": true
      },
      "pricing_calculator": {
        "allowCreateLead": true,
        "enable_lead_submission": true,
        "customCustomerName": "<string>"
      },
      "banner": {}
    },
    "asset_uuid": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
]

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
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. Only the key matching the block_type is relevant: action_bar blocks use action_bar, goals blocks use goals, banner blocks use banner, etc.

asset_uuid
string | null
required

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

created_at
string
required
updated_at
string
required