{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Search Pages API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
      "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Search Pages",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Search Pages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The _name_ metadata value of a specific search page to retrieve (e.g., _mysearchpage_)."
              }
            ]
          },
          "docs": "Gets the JSON definition of search pages hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"VIEW\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Create Search Page",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              }
            ]
          },
          "docs": "Creates a new empty search page in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Create<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"CREATE\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "List Search Pages by Ids",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/ids",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              }
            ]
          },
          "docs": "Gets the JSON definition of search pages hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"VIEW\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "List Pages by Project ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/project/id",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "projectid",
                "value": "",
                "type": "query",
                "description": "The _projectid_ of the pages."
              }
            ]
          },
          "docs": "lists Pages by project id in a [Coveo Cloud organization](https://docs.coveo.com/en/185/). <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"VIEW\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Get Search Page",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/:pageID",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page to retrieve (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              }
            ]
          },
          "docs": "Gets the JSON definition of a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"VIEW\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Update Search Page Metadata",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/:pageID",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page to delete (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              }
            ]
          },
          "docs": "Updates metadata pertaining to a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"EDIT\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Delete a Search Page or in-App Widget",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/:pageID",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page to delete (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              }
            ]
          },
          "docs": "Delete a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"EDIT\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Get Search Page Header",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/:pageID/header",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page to view (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              }
            ]
          },
          "docs": "Gets the JSON definition of a specific search page header hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"VIEW\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Reorder Resources in Search Page Header",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/:pageID/header",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              }
            ]
          },
          "docs": "Updates the order of the JavaScript and CSS resources in the header of a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"EDIT\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Create CSS Resource in a Search Page Header",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/:pageID/header/css",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              }
            ]
          },
          "docs": "Create a CSS resource in the header pertaining to a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"EDIT\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Update CSS Resource in Search Page Header.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/:pageID/header/css/:resourceName",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              },
              {
                "name": "resourceName",
                "value": "",
                "type": "path",
                "description": "The name identifier of the CSS resource (e.g., 'myresource')."
              }
            ]
          },
          "docs": "Updates a CSS resource in the header of a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"EDIT\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Delete CSS Resource in Search Page Header.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/:pageID/header/css/:resourceName",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              },
              {
                "name": "resourceName",
                "value": "",
                "type": "path",
                "description": "The name identifier of the CSS resource (e.g., 'myresource')."
              }
            ]
          },
          "docs": "Removes a CSS resource from the header of a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"EDIT\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Append JavaScript Resource to Search Page Header.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/:pageID/header/javascript",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              }
            ]
          },
          "docs": "Appends a JavaScript resource to the header of a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"EDIT\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Update JavaScript Resource in Search Page Header.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/:pageID/header/javascript/:resourceName",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              },
              {
                "name": "resourceName",
                "value": "",
                "type": "path",
                "description": "The name identifier of the JavaScript resource (e.g., 'myresource')."
              }
            ]
          },
          "docs": "Updates a JavaScript resource in the header of a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"EDIT\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Delete JavaScript Resource in Search Page Header.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/:pageID/header/javascript/:resourceName",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              },
              {
                "name": "resourceName",
                "value": "",
                "type": "path",
                "description": "The name identifier of the JavaScript resource (e.g., 'myresource')."
              }
            ]
          },
          "docs": "Removes a JavaScript resource from the header of a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"EDIT\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Get Search Page JavaScript Search Framework Information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/:pageID/searchui",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page to delete (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              }
            ]
          },
          "docs": "Gets the identifier of the JavaScript Search Framework version currently being used for a specific search page hosted in the target Coveo Cloud organization, and lists the newer versions this search page can be upgraded to. <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"VIEW\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Change the JavaScript Search Framework Resources",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/:pageID/searchui",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page to delete (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              },
              {
                "name": "major",
                "value": "",
                "type": "query",
                "description": "The major version identifier of the JavaScript Search Framework version to upgrade the target search page to (e.g., _2_)."
              },
              {
                "name": "minor",
                "value": "",
                "type": "query",
                "description": "The minor version identifier of the JavaScript Search Framework version to upgrade the target search page to (e.g., _4710_)."
              }
            ]
          },
          "docs": "Change the JavaScript Search Framework resources associated to a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"EDIT\", \"targetId\": \"*\" }```</details>"
        }
      ]
    }
  ],
  "bundled": true
}