DUduda
Site Collections

Get collection by name

Returns the collection with the given name.

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

Request

  • Base URL
    https://api.duda.co
  • URL
    https://api.duda.co/api/sites/multiscreen/{site_name}/collection/{collection_name}
  • Auth
    HTTP basic

Path parameters

site_namestring required

The site's unique name (its ID), returned when the site is created.

collection_namestring required

The collection's name.

Response

OK

base_refresh_intervalstring Duration (ISO 8601) nullable

Configured frequency for automatic external collection data refresh.

customer_lock'unlocked, structure_locked, locked'

Lock state for customer editing. Supported values:

  • 'unlocked' - customers have no limitations for editing collection fields or data. null value in response is equivalent to 'unlocked' state
  • 'structure_locked' - customers can't edit, add or remove collection fields
  • 'view_only' - customers can't edit fields and internal collection data Following logic & limitations is applied in create/update requests:
  • null value will not change collection lock state
  • image collections can only be locked for 'view_only' state
  • external collections can only be locked for 'structure_locked' state
item_countinteger
namestring
regular_page_bindableboolean

Whether collection is bindable to non-dynamic pages. See feature support article for more details: https://support.duda.co/hc/en-us/articles/26519925982487-Dynamic-Content-Collections-for-Regular-Pages

static_page_bindableboolean

Example response

{
  "base_refresh_interval": "PT1H"
}

Changes

No recorded changes to this operation across all 1 revision of this API.