{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Listing Configurations 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": "Listing Configurations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieves a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/configurations/listings/:configurationId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "configurationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the listing configuration."
              }
            ]
          },
          "docs": "**WILL BE DEPRECATED ON 2026-08-31: See [this page](https://docs.coveo.com/en/q4dd0300/deprecations/search-and-listing-configuration-apis-deprecation) for more details.**</br></br>Shows a Listing configuration in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/configurations/listings/:configurationId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "configurationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the listing configuration."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**WILL BE DEPRECATED ON 2026-08-31: See [this page](https://docs.coveo.com/en/q4dd0300/deprecations/search-and-listing-configuration-apis-deprecation) for more details.**</br></br>Updates a Listing configuration in a [listing](https://docs.coveo.com/en/m1sf3187/).</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{body.trackingId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Deletes a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/configurations/listings/:configurationId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "configurationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the listing configuration."
              }
            ]
          },
          "docs": "**WILL BE DEPRECATED ON 2026-08-31: See [this page](https://docs.coveo.com/en/q4dd0300/deprecations/search-and-listing-configuration-apis-deprecation) for more details.**</br></br>Deletes a Listing configuration in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Retrieves the Global Listing Configuration for the Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/configurations/listings/global",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              }
            ]
          },
          "docs": "Shows the global GlobalListing configuration. Does not accept pin rules. in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update the Global Listing Configuration for the Organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/configurations/listings/global",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the global GlobalListing configuration. Does not accept pin rules. to be applied for the whole organization in a [listing](https://docs.coveo.com/en/m1sf3187/).</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{body.trackingId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Retrieves All Listing Configurations of an Organization. WILL BE DEPRECATED on 2026-08-31.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/configurations/listings",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              },
              {
                "name": "query",
                "value": "Surf With Us Th",
                "type": "query",
                "description": "Filter on names when requesting listing configuration names & IDs. Will perform '*query*' match pattern."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based index number of the page of listing configurations to retrieve.</br>**Minimum:** `0`</br>**Default:** `0`"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of listing configurations to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:** `10`"
              }
            ]
          },
          "docs": "**WILL BE DEPRECATED ON 2026-08-31: See [this page](https://docs.coveo.com/en/q4dd0300/deprecations/search-and-listing-configuration-apis-deprecation) for more details.**</br></br>Lists all the Listing configuration in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create a Listing Configuration. WILL BE DEPRECATED on 2026-08-31.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/configurations/listings",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**WILL BE DEPRECATED ON 2026-08-31: See [this page](https://docs.coveo.com/en/q4dd0300/deprecations/search-and-listing-configuration-apis-deprecation) for more details.**</br></br>Creates a Listing configuration in a [listing](https://docs.coveo.com/en/m1sf3187/).</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{body.trackingId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Retrieves a Listing Configuration by Its Matching Url. WILL BE DEPRECATED on 2026-08-31.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/configurations/listings/url",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              },
              {
                "name": "url",
                "value": "",
                "type": "query",
                "description": "URL"
              }
            ]
          },
          "docs": "**WILL BE DEPRECATED ON 2026-08-31: See [this page](https://docs.coveo.com/en/q4dd0300/deprecations/search-and-listing-configuration-apis-deprecation) for more details.**</br></br>Shows a Listing configuration in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Retrieves All Rules Related to Listings of an Organization. WILL BE DEPRECATED on 2026-08-31.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/configurations/listings/rules",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              },
              {
                "name": "configurationId",
                "value": "644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b",
                "type": "query",
                "description": "The unique identifier of the listing configuration."
              },
              {
                "name": "name",
                "value": "Small name for a rule",
                "type": "query",
                "description": "Filter on rule name when requesting rules."
              },
              {
                "name": "scope",
                "value": "specific",
                "type": "query",
                "description": "Rule scope to return. One of: [specific, global]. Returns all if not specified."
              },
              {
                "name": "essential",
                "value": "false",
                "type": "query",
                "description": "Indicates if the rule is essential to the listing page; the essential rule is added during page creation. Returns all rules if not specified."
              },
              {
                "name": "language",
                "value": "en",
                "type": "query",
                "description": "An ISO 639-1 language code."
              },
              {
                "name": "country",
                "value": "US",
                "type": "query",
                "description": "An ISO 3166-1 alpha-2 country code."
              },
              {
                "name": "currency",
                "value": "USD",
                "type": "query",
                "description": "An ISO 4217 currency code."
              },
              {
                "name": "actions",
                "value": "[boost]",
                "type": "query",
                "description": "Rule action type to return. One of: [boost, bury, pin, include, exclude, onlyShow]. Returns all if not specified."
              },
              {
                "name": "sort",
                "value": "name.asc",
                "type": "query",
                "description": "List of property.direction to sort by"
              },
              {
                "name": "scheduleFilter",
                "value": "liveRules",
                "type": "query",
                "description": "The schedule filter to apply."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based index number of the page of rules to retrieve.</br>**Minimum:** `0`</br>**Default:** `0`"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of rules to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:** `10`"
              }
            ]
          },
          "docs": "**WILL BE DEPRECATED ON 2026-08-31: See [this page](https://docs.coveo.com/en/q4dd0300/deprecations/search-and-listing-configuration-apis-deprecation) for more details.**</br></br>Lists listing related rules in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Retrieves All Listing Configurations Ids & Names of an Organization. WILL BE DEPRECATED on 2026-08-31.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/configurations/listings/names",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              },
              {
                "name": "query",
                "value": "Surf With Us Th",
                "type": "query",
                "description": "Filter on names when requesting listing configuration names & IDs. Will perform '*query*' match pattern."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based index number of the page of listing configurations to retrieve.</br>**Minimum:** `0`</br>**Default:** `0`"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of listing configurations to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:** `10`"
              }
            ]
          },
          "docs": "**WILL BE DEPRECATED ON 2026-08-31: See [this page](https://docs.coveo.com/en/q4dd0300/deprecations/search-and-listing-configuration-apis-deprecation) for more details.**</br></br>Lists all ids and names of the Listing configuration in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</de"
        }
      ]
    }
  ],
  "bundled": true
}