v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

List Sites

get/sites/multiscreen

Query parameters

offsetinteger

Zero-based offset for elements (0..N).

limitinteger

The size of the page to be returned (Max 100).

sortstring

One of CREATION_DATE or LAST_PUBLICATION_DATE.

directionstring

Sort direction. One of ASC or DESC.

publish_statusstring

Filter by publication status. One of PUBLISHED, UNPUBLISHED or NOT_PUBLISHED_YET. Multiple values can be passed as a comma separated list. Multiple values will be evaluated as an OR statement.

label_namesstring

Filter by site labels. Multiple values can be passed as a comma separated list. Multiple values will be evaluated as an OR statement.

last_published_date.gtestring

Filter by sites published after specified date e.g., 2016-07-09T22:33:44.

last_published_date.ltestring

Filter by sites published before specified date e.g., 2016-07-09T22:33:44.

creation_date.gtestring

Filter by sites created after specified date e.g., 2016-07-09T22:33:44.

creation_date.ltestring

Filter by sites created before specified date e.g., 2016-07-09T22:33:44.

Response

200

limitinteger

offsetinteger

total_responsesinteger

Example response

{
  "results": [
    {
      "account_name": "string",
      "additionalLanguages": [
        "string"
      ],
      "canonical_url": "string",
      "content_collection_form": {
        "url": "https://editor.whitelabel.com/site-form/Q_4jrh8-GO5MmeCUBm09pHpWVHvGDC9xg60UrQ7n",
        "url_expiration_date": "2025-04-12T16:12:56"
      },
      "cookie_notification": {
        "enabled": true
      },
      "creation_date": "string",
      "edit_site_url": "string",
      "editor": "ADVANCED",
      "external_uid": "string",
      "fav_icon": "string",
      "first_published_date": "string",
      "force_https": true,
      "google_tracking_id": "string",
      "googletagmanager_container_id": [
        "string"
      ],
      "labels": [
        {
          "name": "string"
        }
      ],
      "lang": "string",
      "last_published_date": "string",
      "last_reset_by": "string",
      "modification_date": "string",
      "overview_site_url": "string",
      "piwik_id": "string",
      "preview_site_url": "string",
      "publish_status": "NOT_PUBLISHED_YET",
      "site_alternate_domains": {
        "domains": [
          "example.org"
        ],
        "is_redirect": true
      },
      "site_default_domain": "string",
      "site_domain": "string",
      "site_name": "string",
      "store_status": "NONE",
      "store_type": "NATIVE",
      "thumbnail_url": "string"
    }
  ]
}

All 247 operations