Docs
V1 APIConnections

List content blocks

Enabled content blocks (content groups) with enabled nested content items. Optionally filter the collection by comma-separated website connection keys. Scoped to the portfolio: `{property}` is a slug resolved against the properties attached to `{connection}`, so a slug outside this portfolio is a `404` rather than another site's property.

GET/api/v1/connection/{connection}/property/{property}/content-groups

Enabled content blocks (content groups) with enabled nested content items. Optionally filter the collection by comma-separated website connection keys. Scoped to the portfolio: {property} is a slug resolved against the properties attached to {connection}, so a slug outside this portfolio is a 404 rather than another site's property.

Path Parameters

connection*string

Connection UUID.

Formatuuid
property*string

Property slug, resolved against the properties attached to {connection}. A slug outside that portfolio is a 404. Slug only — a UUID does not resolve here.

Query Parameters

website_connection_keys?string

Comma-separated website connection keys. Whitespace and duplicate values are ignored. When omitted, all enabled content blocks are returned; when present but empty, no content blocks are returned.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/connection/497f6eca-6276-4993-bfeb-53cbbbba6f08/property/1520-gough-street/content-groups"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "string",      "media_type": "string",      "internal_title": "string",      "title": "string",      "subtitle": "string",      "description": "string",      "link_primary_url": "http://example.com",      "link_primary_text": "string",      "link_secondary_url": "http://example.com",      "link_secondary_text": "string",      "images": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "thumb_url": "http://example.com",          "full_url": "http://example.com",          "caption": "string",          "alt_text": "string",          "tags": [            "string"          ],          "tags_string": "string",          "reference_url": "http://example.com",          "title": "string"        }      ],      "videos": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "provider": "string",          "url": "http://example.com",          "title": "string",          "settings": {},          "image": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "thumb_url": "http://example.com",            "full_url": "http://example.com",            "caption": "string",            "alt_text": "string",            "tags": [              "string"            ],            "tags_string": "string",            "reference_url": "http://example.com",            "title": "string"          },          "tags": [            "string"          ],          "tags_string": "string"        }      ],      "virtual_tours": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "provider": "string",          "url": "http://example.com",          "title": "string",          "settings": {},          "image": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "thumb_url": "http://example.com",            "full_url": "http://example.com",            "caption": "string",            "alt_text": "string",            "tags": [              "string"            ],            "tags_string": "string",            "reference_url": "http://example.com",            "title": "string"          },          "tags": [            "string"          ],          "tags_string": "string"        }      ],      "background_image": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "thumb_url": "http://example.com",        "full_url": "http://example.com",        "caption": "string",        "alt_text": "string",        "tags": [          "string"        ],        "tags_string": "string",        "reference_url": "http://example.com",        "title": "string"      },      "elements_key": "string",      "content_items": [        {}      ]    }  ]}

List announcements GET

Enabled announcements active at request time. Scoped to the portfolio: `{property}` is a slug resolved against the properties attached to `{connection}`, so a slug outside this portfolio is a `404` rather than another site's property.

Get content conditionals GET

Flags indicating which content sections have renderable content, so a template can skip empty sections. Scoped to the portfolio: `{property}` is a slug resolved against the properties attached to `{connection}`, so a slug outside this portfolio is a `404` rather than another site's property.