Docs
V2 APIContent Blocks

List content blocks

GET/api/v2/content-blocks

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

account_id?string

Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.

Formatuuid
per_page?integer
Range1 <= value <= 200
Default15
property_id?string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/content-blocks"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "property_ids": [        "03729b6d-baa6-45e3-8afa-c6e3d7ae6182"      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "internal_title": "string",      "is_enabled": true,      "is_global": true,      "type": "single",      "media_type": "gallery",      "title": "string",      "subtitle": "string",      "description": "string",      "link_primary_url": "string",      "link_primary_text": "string",      "link_secondary_url": "string",      "link_secondary_text": "string",      "sort_order": 0,      "elements_key": "string",      "internal_tags": [        null      ],      "content_items": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "created_at": "2019-08-24T14:15:22Z",          "updated_at": "2019-08-24T14:15:22Z",          "content_group_id": "17c604e2-2aa3-4de8-b888-cde53a704b3f",          "is_enabled": true,          "media_type": "gallery",          "internal_title": "string",          "title": "string",          "meta": "string",          "text": "string",          "link_primary_url": "string",          "link_primary_text": "string",          "link_secondary_url": "string",          "link_secondary_text": "string",          "sort_order": 0,          "images": [            {              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",              "url": "string",              "thumb_url": "string",              "full_url": "string",              "caption": "string",              "alt_text": "string",              "tags": [                "string"              ],              "reference_url": "string",              "reference_id": "string",              "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",              "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"            }          ],          "background_image": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "url": "string",            "thumb_url": "string",            "full_url": "string",            "caption": "string",            "alt_text": "string",            "tags": [              "string"            ],            "reference_url": "string",            "reference_id": "string",            "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",            "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"          },          "videos": [            {              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",              "type": "string",              "provider": "string",              "url": "string",              "title": "string",              "settings": {},              "tags": [                "string"              ],              "sort_order": 0,              "image": {                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",                "url": "string",                "thumb_url": "string",                "full_url": "string",                "caption": "string",                "alt_text": "string",                "tags": [                  "string"                ],                "reference_url": "string",                "reference_id": "string",                "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",                "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"              }            }          ],          "virtual_tours": [            {              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",              "type": "string",              "provider": "string",              "url": "string",              "title": "string",              "settings": {},              "tags": [                "string"              ],              "sort_order": 0,              "image": {                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",                "url": "string",                "thumb_url": "string",                "full_url": "string",                "caption": "string",                "alt_text": "string",                "tags": [                  "string"                ],                "reference_url": "string",                "reference_id": "string",                "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",                "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"              }            }          ]        }      ],      "images": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "url": "string",          "thumb_url": "string",          "full_url": "string",          "caption": "string",          "alt_text": "string",          "tags": [            "string"          ],          "reference_url": "string",          "reference_id": "string",          "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",          "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"        }      ],      "background_image": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "url": "string",        "thumb_url": "string",        "full_url": "string",        "caption": "string",        "alt_text": "string",        "tags": [          "string"        ],        "reference_url": "string",        "reference_id": "string",        "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",        "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"      },      "videos": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "type": "string",          "provider": "string",          "url": "string",          "title": "string",          "settings": {},          "tags": [            "string"          ],          "sort_order": 0,          "image": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "url": "string",            "thumb_url": "string",            "full_url": "string",            "caption": "string",            "alt_text": "string",            "tags": [              "string"            ],            "reference_url": "string",            "reference_id": "string",            "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",            "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"          }        }      ],      "virtual_tours": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "type": "string",          "provider": "string",          "url": "string",          "title": "string",          "settings": {},          "tags": [            "string"          ],          "sort_order": 0,          "image": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "url": "string",            "thumb_url": "string",            "full_url": "string",            "caption": "string",            "alt_text": "string",            "tags": [              "string"            ],            "reference_url": "string",            "reference_id": "string",            "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",            "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901"          }        }      ]    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 0,    "from": 0,    "last_page": 0,    "links": [      {        "url": "string",        "label": "string",        "page": 0,        "active": true      }    ],    "path": "string",    "per_page": 200,    "to": 0,    "total": 0  }}