{ "info": { "_postman_id": "56e2687a-af52-4a6f-adb8-da6f1fb3680d", "name": "Coveo Activity Activities Catalog Filter API", "description": "API for Coveo Platform\n\nContact Support:\n Name: Coveo", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:27:31.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "lastUpdatedBy": "35240", "uid": "35240-56e2687a-af52-4a6f-adb8-da6f1fb3680d" }, "item": [ { "name": "api", "item": [ { "name": "preview", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "catalog-management", "item": [ { "name": "catalogs", "item": [ { "name": "{catalogId}", "item": [ { "name": "filter", "item": [ { "name": "Get Filter for a Catalog", "id": "0207ada1-7008-4c1e-9c15-23029efdf4c3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/api/preview/organizations/:organizationId/catalog-management/catalogs/:catalogId/filter", "host": [ "{{baseUrl}}" ], "path": [ "api", "preview", "organizations", ":organizationId", "catalog-management", "catalogs", ":catalogId", "filter" ], "variable": [ { "id": "f3c77f1c-6c30-4b04-8bbf-2417f67ef369", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`" }, { "id": "72595b0d-3890-40cd-9cb6-31d2ef403c75", "key": "catalogId", "value": "", "description": "(Required) The unique identifier of the [catalog](https://docs.coveo.com/en/3143/)." } ] }, "description": "Retrieves the filter for a specific catalog.

**Required privilege:** Catalogs - View

Privilege required\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"CATALOG\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "381788c7-b698-41fd-bf48-d1da6f20d715", "name": "Catalog filter retrieved successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/preview/organizations/:organizationId/catalog-management/catalogs/:catalogId/filter", "host": [ "{{baseUrl}}" ], "path": [ "api", "preview", "organizations", ":organizationId", "catalog-management", "catalogs", ":catalogId", "filter" ], "variable": [ { "key": "organizationId" }, { "key": "catalogId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"filter\": {\n \"field\": \"\",\n \"value\": \"\"\n }\n}", "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-381788c7-b698-41fd-bf48-d1da6f20d715" }, { "id": "6f8fe112-2c70-4da2-b70d-47e7416d198c", "name": "Organization or catalog not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/preview/organizations/:organizationId/catalog-management/catalogs/:catalogId/filter", "host": [ "{{baseUrl}}" ], "path": [ "api", "preview", "organizations", ":organizationId", "catalog-management", "catalogs", ":catalogId", "filter" ], "variable": [ { "key": "organizationId" }, { "key": "catalogId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"filter\": {\n \"field\": \"\",\n \"value\": \"\"\n }\n}", "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-6f8fe112-2c70-4da2-b70d-47e7416d198c" }, { "id": "fc91b6b8-d438-4929-b589-ae318199979a", "name": "Catalog filters feature is unavailable", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/preview/organizations/:organizationId/catalog-management/catalogs/:catalogId/filter", "host": [ "{{baseUrl}}" ], "path": [ "api", "preview", "organizations", ":organizationId", "catalog-management", "catalogs", ":catalogId", "filter" ], "variable": [ { "key": "organizationId" }, { "key": "catalogId" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"filter\": {\n \"field\": \"\",\n \"value\": \"\"\n }\n}", "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-fc91b6b8-d438-4929-b589-ae318199979a" } ], "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-0207ada1-7008-4c1e-9c15-23029efdf4c3" }, { "name": "Create or Update the Filter for a Catalog", "id": "891ff1a8-0ce2-47f0-ba84-83948b375721", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"filter\": {\n \"field\": \"\",\n \"value\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/preview/organizations/:organizationId/catalog-management/catalogs/:catalogId/filter", "host": [ "{{baseUrl}}" ], "path": [ "api", "preview", "organizations", ":organizationId", "catalog-management", "catalogs", ":catalogId", "filter" ], "variable": [ { "id": "c8616886-6fc1-4efb-8f60-c026c5f6eb20", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`" }, { "id": "406b285a-58fc-41a4-9a2f-052b1ba3d4de", "key": "catalogId", "value": "", "description": "(Required) The unique identifier of the [catalog](https://docs.coveo.com/en/3143/)." } ] }, "description": "Creates or updates the filter for a specific catalog.

**Required privilege:** Catalogs - Edit

Privilege required\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"CATALOG\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "136ed234-6e6c-4f81-9166-b6462aa58acf", "name": "Catalog filter updated successfully", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"filter\": {\n \"field\": \"\",\n \"value\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/preview/organizations/:organizationId/catalog-management/catalogs/:catalogId/filter", "host": [ "{{baseUrl}}" ], "path": [ "api", "preview", "organizations", ":organizationId", "catalog-management", "catalogs", ":catalogId", "filter" ], "variable": [ { "key": "organizationId" }, { "key": "catalogId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"filter\": {\n \"field\": \"\",\n \"value\": \"\"\n }\n}", "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-136ed234-6e6c-4f81-9166-b6462aa58acf" }, { "id": "973c8299-546b-4af2-b11b-2a69bca0c05e", "name": "Organization or catalog not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"filter\": {\n \"field\": \"\",\n \"value\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/preview/organizations/:organizationId/catalog-management/catalogs/:catalogId/filter", "host": [ "{{baseUrl}}" ], "path": [ "api", "preview", "organizations", ":organizationId", "catalog-management", "catalogs", ":catalogId", "filter" ], "variable": [ { "key": "organizationId" }, { "key": "catalogId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"filter\": {\n \"field\": \"\",\n \"value\": \"\"\n }\n}", "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-973c8299-546b-4af2-b11b-2a69bca0c05e" }, { "id": "805a76af-4e66-44f7-9c7c-e346e10096e2", "name": "Precondition failed. Check the error message.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"filter\": {\n \"field\": \"\",\n \"value\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/preview/organizations/:organizationId/catalog-management/catalogs/:catalogId/filter", "host": [ "{{baseUrl}}" ], "path": [ "api", "preview", "organizations", ":organizationId", "catalog-management", "catalogs", ":catalogId", "filter" ], "variable": [ { "key": "organizationId" }, { "key": "catalogId" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"filter\": {\n \"field\": \"\",\n \"value\": \"\"\n }\n}", "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-805a76af-4e66-44f7-9c7c-e346e10096e2" } ], "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-891ff1a8-0ce2-47f0-ba84-83948b375721" } ], "id": "ee1f4fb3-856b-4fe0-bb27-c0d85ae602e9", "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-ee1f4fb3-856b-4fe0-bb27-c0d85ae602e9" } ], "id": "6e54cff5-6ea4-4d89-8020-5f863391b9d2", "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-6e54cff5-6ea4-4d89-8020-5f863391b9d2" } ], "id": "30c9dc38-680a-4922-a3e3-bf464678df62", "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-30c9dc38-680a-4922-a3e3-bf464678df62" } ], "id": "28b0975d-99a5-49b2-b532-5942c6ff9136", "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-28b0975d-99a5-49b2-b532-5942c6ff9136" } ], "id": "48265f35-863e-475b-85d0-ce6706615776", "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-48265f35-863e-475b-85d0-ce6706615776" } ], "id": "1cfff774-1b3c-483a-99a0-d32389c905eb", "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-1cfff774-1b3c-483a-99a0-d32389c905eb" } ], "id": "24401723-a4c6-45a8-b5ae-1fd8a341d308", "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-24401723-a4c6-45a8-b5ae-1fd8a341d308" } ], "id": "bb0aebbf-566d-4aac-a74b-249a6f72d703", "createdAt": "2026-07-28T01:27:32.000Z", "updatedAt": "2026-07-28T01:27:32.000Z", "uid": "35240-bb0aebbf-566d-4aac-a74b-249a6f72d703" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://platform.cloud.coveo.com" } ] }