v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

Get Collection

Get the fields and data of an existing collection

get/sites/multiscreen/{site_name}/collection/{collection_name}

Path parameters

site_namestring required

A valid site name of an existing website

collection_namestring required

Name of the current collection

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"
    }
  ]
}