v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

List Collections

Get all collections that exist on this website.

get/sites/multiscreen/{site_name}/collection

Path parameters

site_namestring required

A valid site name of an existing website

Response

200

customer_lockstring

item_countinteger

namestring

regular_page_bindableboolean

base_refresh_intervalstring

Example response

[
  {
    "customer_lock": "unlocked",
    "external_details": {
      "authorization_header_value": "string",
      "collection_data_json_path": "string",
      "custom_headers": [
        {
          "name": "string",
          "values": [
            "string"
          ]
        }
      ],
      "enabled": true,
      "external_endpoint": "string",
      "external_id": "string",
      "page_item_url_field": "string"
    },
    "fields": [
      {
        "multi_select_options": [
          "string"
        ],
        "name": "string",
        "type": "string"
      }
    ],
    "name": "string",
    "regular_page_bindable": true,
    "values": [
      {
        "id": "string",
        "page_item_url": "string"
      }
    ]
  }
]