{ "info": { "_postman_id": "43eb46c7-2b41-4c77-b00b-21f25e440ed0", "name": "Coveo Activity Activities Search Page Configuration 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:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "lastUpdatedBy": "35240", "uid": "35240-43eb46c7-2b41-4c77-b00b-21f25e440ed0" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "searchpage", "item": [ { "name": "v1", "item": [ { "name": "interfaces", "item": [ { "name": "{interfaceId}", "item": [ { "name": "accesses", "item": [ { "name": "users", "item": [ { "name": "Get the List of Users with Access to the Search Page.", "id": "3165601f-b2ea-40c8-8ffe-51e8196968a3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/accesses/users", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "accesses", "users" ], "variable": [ { "id": "c7591925-be58-4379-9320-dfaf8989aff7", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "9d3666f9-0e19-4c5e-b09d-8b7f566cb8b1", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target search interface." } ] }, "description": "Get a user with access to a given search page interface in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "2c221aff-de56-491e-bcae-c54b6d082738", "name": "Ok", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/accesses/users", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "accesses", "users" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n \"\",\n \"\"\n]", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-2c221aff-de56-491e-bcae-c54b6d082738" }, { "id": "9d4f145d-4737-47c6-9340-21c20d6aac98", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/accesses/users", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "accesses", "users" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-9d4f145d-4737-47c6-9340-21c20d6aac98" } ], "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-3165601f-b2ea-40c8-8ffe-51e8196968a3" }, { "name": "Update the List of Users with Access to a Search Page.", "id": "7f002a8b-22a9-4592-af34-7ecc7bbf98cd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/accesses/users", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "accesses", "users" ], "variable": [ { "id": "4bf3b052-637d-4fd1-a240-be1b521b7de1", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "682affed-90c8-4cb5-82fc-3f4d6a4647a7", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target search interface." } ] }, "description": "Set list of users with access to a given search page interface in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "40989e06-6230-478e-8d4f-153c016702aa", "name": "Ok", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/accesses/users", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "accesses", "users" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"grid\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"LARGE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n },\n \"created\": \"\",\n \"createdBy\": \"\",\n \"updated\": \"\",\n \"updatedBy\": \"\"\n}", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-40989e06-6230-478e-8d4f-153c016702aa" }, { "id": "1764d9ee-3e12-4001-a973-d0ab395b0d12", "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/accesses/users", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "accesses", "users" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-1764d9ee-3e12-4001-a973-d0ab395b0d12" } ], "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-7f002a8b-22a9-4592-af34-7ecc7bbf98cd" }, { "name": "Add a Search Page Interface User Access", "id": "6ad1fd72-fffb-4123-815f-35d7e57296fa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"users\": [\n \"\",\n \"\"\n ],\n \"message\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/accesses/users?notify=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "accesses", "users" ], "query": [ { "description": "Whether to send an email notification to new search page users.", "key": "notify", "value": "" } ], "variable": [ { "id": "61adb3fc-ba0a-4c80-9b7f-c5fe92215a52", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "f7d0496b-7ced-4063-add0-c81e7c597c48", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target search interface." } ] }, "description": "Add users to list of users with access to given search page in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "4595c84c-644e-4877-9b4a-e85b76485aec", "name": "Ok", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"users\": [\n \"\",\n \"\"\n ],\n \"message\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/accesses/users?notify=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "accesses", "users" ], "query": [ { "description": "Whether to send an email notification to new search page users.", "key": "notify", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"grid\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"LARGE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n },\n \"created\": \"\",\n \"createdBy\": \"\",\n \"updated\": \"\",\n \"updatedBy\": \"\"\n}", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-4595c84c-644e-4877-9b4a-e85b76485aec" } ], "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-6ad1fd72-fffb-4123-815f-35d7e57296fa" } ], "id": "0939144f-eb49-4ea5-8c1b-ade6018f044a", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-0939144f-eb49-4ea5-8c1b-ade6018f044a" }, { "name": "Get a Search Page Interface's Access Configuration", "id": "87a64443-e0a6-41b4-b229-06b41a888bc3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/accesses", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "accesses" ], "variable": [ { "id": "5bdfd78e-aba3-4a92-adf8-dfe6a4c9fca1", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "2345fb35-e76e-4531-99e5-17f11b2b8ab5", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target search interface." } ] }, "description": "Get a search page interface access in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "161192ab-0461-484a-b2c2-14fc8f8b6387", "name": "Ok", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/accesses", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "accesses" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n}", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-161192ab-0461-484a-b2c2-14fc8f8b6387" }, { "id": "01d26200-df6f-48b0-924c-f9bea741143c", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/accesses", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "accesses" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-01d26200-df6f-48b0-924c-f9bea741143c" } ], "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-87a64443-e0a6-41b4-b229-06b41a888bc3" }, { "name": "Update a Search Page Interface's Access Configuration", "id": "0013148b-ce79-4b82-ad41-5a9e215ffc5f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/search-page-interface-access not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/accesses", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "accesses" ], "variable": [ { "id": "88d75176-da9e-4913-b790-cd24c6c32f87", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "d98faa74-b250-4f53-ae84-1229aa604cfd", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target search interface." } ] }, "description": "Update a search page interface access in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "a8e76143-053c-4da0-9c46-35bde04db3b2", "name": "Ok", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/search-page-interface-access not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/accesses", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "accesses" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/components/schemas/search-page-interface-access not found in the OpenAPI spec\"\n}", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-a8e76143-053c-4da0-9c46-35bde04db3b2" }, { "id": "e1c8d4ce-3094-4724-8965-d1de33ab02a5", "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"reference #/components/schemas/search-page-interface-access not found in the OpenAPI spec\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/accesses", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "accesses" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-e1c8d4ce-3094-4724-8965-d1de33ab02a5" } ], "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-0013148b-ce79-4b82-ad41-5a9e215ffc5f" } ], "id": "6a291b6f-2d90-49c1-8df9-0631a4760983", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-6a291b6f-2d90-49c1-8df9-0631a4760983" }, { "name": "access", "item": [ { "name": "request", "item": [ { "name": "Request Search Page Interface Access", "id": "dafac2ad-740a-4522-8b7b-ffc18000ba4e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/access/request", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "access", "request" ], "variable": [ { "id": "481dca24-f8c4-4a05-affe-2c8cc5d14474", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "dee18f19-ca4f-482b-838e-f67eb929e9ee", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target search interface." } ] }, "description": "Request access to a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "a76f139d-54e4-4254-9d93-0b152f24b342", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/access/request", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "access", "request" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-a76f139d-54e4-4254-9d93-0b152f24b342" }, { "id": "1b9cd151-dd81-4003-a408-5dcf8d7ce72e", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/access/request", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "access", "request" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-1b9cd151-dd81-4003-a408-5dcf8d7ce72e" }, { "id": "a2e95005-1512-4712-8b74-94da2e1e20e2", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/access/request", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "access", "request" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-a2e95005-1512-4712-8b74-94da2e1e20e2" } ], "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-dafac2ad-740a-4522-8b7b-ffc18000ba4e" } ], "id": "f1745ab1-d549-4915-b791-2255e5eb9e6f", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-f1745ab1-d549-4915-b791-2255e5eb9e6f" } ], "id": "aca3f493-0ac2-4eef-8cc8-4c9f3b7c6dfb", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-aca3f493-0ac2-4eef-8cc8-4c9f3b7c6dfb" }, { "name": "preview", "item": [ { "name": "Preview Search Page Interface", "id": "6563689e-5285-4138-9b02-a96ab367678f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/html" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"grid\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"LARGE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n },\n \"created\": \"\",\n \"createdBy\": \"\",\n \"updated\": \"\",\n \"updatedBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/preview", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "preview" ], "variable": [ { "id": "cd4d0cab-fff9-439a-a58e-f338bc559753", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "60099acb-8ebe-4323-8c42-c2853e1f85dd", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target search interface." } ] }, "description": "Generate the markup of a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "20ef5e47-5b13-4051-aa27-71a034d8f0bf", "name": "Ok", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/html" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"grid\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"LARGE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n },\n \"created\": \"\",\n \"createdBy\": \"\",\n \"updated\": \"\",\n \"updatedBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/preview", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "preview" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/html" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-20ef5e47-5b13-4051-aa27-71a034d8f0bf" }, { "id": "d2d81267-9fd3-49ea-8beb-8672add000a2", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"grid\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"LARGE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n },\n \"created\": \"\",\n \"createdBy\": \"\",\n \"updated\": \"\",\n \"updatedBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/preview", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "preview" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-d2d81267-9fd3-49ea-8beb-8672add000a2" }, { "id": "e27f275f-8a74-4419-b67b-071cb652174b", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"grid\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"LARGE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n },\n \"created\": \"\",\n \"createdBy\": \"\",\n \"updated\": \"\",\n \"updatedBy\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/preview", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "preview" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-e27f275f-8a74-4419-b67b-071cb652174b" } ], "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-6563689e-5285-4138-9b02-a96ab367678f" } ], "id": "5e056243-d061-44d9-93ac-c8bd1b7e93cc", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-5e056243-d061-44d9-93ac-c8bd1b7e93cc" }, { "name": "pipelines", "item": [ { "name": "Get Search Page Interface Pipelines", "id": "70d6e1e9-bf46-49c5-9fc1-f3d1950d9f86", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/pipelines", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "pipelines" ], "variable": [ { "id": "ce624060-d1fe-419a-b8cd-57ae8c23ebd8", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "29b570a6-dfb0-4a9a-9beb-040b8f386831", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target search interface." } ] }, "description": "Get the pipelines used by a search page in a [Coveo organization](https://docs.coveo.com/en/185/) in the builder context." }, "response": [ { "id": "367fde2c-08e1-42d3-977c-01780c774a4a", "name": "Ok", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/pipelines", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "pipelines" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"pipelineType\": \"\",\n \"conditionId\": \"\",\n \"models\": [\n {\n \"id\": \"\",\n \"modelStatus\": \"\",\n \"modelEngine\": \"\"\n },\n {\n \"id\": \"\",\n \"modelStatus\": \"\",\n \"modelEngine\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"pipelineType\": \"\",\n \"conditionId\": \"\",\n \"models\": [\n {\n \"id\": \"\",\n \"modelStatus\": \"\",\n \"modelEngine\": \"\"\n },\n {\n \"id\": \"\",\n \"modelStatus\": \"\",\n \"modelEngine\": \"\"\n }\n ]\n }\n]", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-367fde2c-08e1-42d3-977c-01780c774a4a" }, { "id": "e606f962-afc4-49cd-83a0-07315ac1840a", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId/pipelines", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId", "pipelines" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-e606f962-afc4-49cd-83a0-07315ac1840a" } ], "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-70d6e1e9-bf46-49c5-9fc1-f3d1950d9f86" } ], "id": "aa1f3daf-4377-40cb-a240-04d20fb8cb84", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-aa1f3daf-4377-40cb-a240-04d20fb8cb84" }, { "name": "Get a Search Page Interface", "id": "d5b126e1-6ec3-45af-9e9c-a90c5d45e665", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId" ], "variable": [ { "id": "27781054-df1e-432d-ba87-37242e0acb3f", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "0ab2cdaf-ff99-49e6-a0ea-69a4d16d7a41", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target search interface." } ] }, "description": "Get a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "2370e350-2377-4ef3-b4be-25e751a88398", "name": "Ok", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"grid\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"LARGE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n },\n \"created\": \"\",\n \"createdBy\": \"\",\n \"updated\": \"\",\n \"updatedBy\": \"\"\n}", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-2370e350-2377-4ef3-b4be-25e751a88398" }, { "id": "4c3fe0b2-1231-44b1-9420-1e2f2a4631a0", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-4c3fe0b2-1231-44b1-9420-1e2f2a4631a0" } ], "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-d5b126e1-6ec3-45af-9e9c-a90c5d45e665" }, { "name": "Update a Search Page Interface", "id": "dc6ff92c-2b1e-4853-b090-fa3c3e96d0de", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"relevancy\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"ASC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"list\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"SMALL\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId" ], "variable": [ { "id": "ad48a464-4cf6-463f-b7e1-306effbfe149", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "f16083d5-e0f3-42b6-b3d9-564d33a4826c", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target search interface." } ] }, "description": "Update a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "77e9b807-9afd-4833-8e0c-02fbc1ccb5ea", "name": "Ok", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"relevancy\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"ASC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"list\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"SMALL\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"grid\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"LARGE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n },\n \"created\": \"\",\n \"createdBy\": \"\",\n \"updated\": \"\",\n \"updatedBy\": \"\"\n}", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-77e9b807-9afd-4833-8e0c-02fbc1ccb5ea" }, { "id": "27061a6a-395d-4bce-8a4b-36c7592b85e7", "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"relevancy\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"ASC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"list\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"SMALL\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-27061a6a-395d-4bce-8a4b-36c7592b85e7" } ], "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-dc6ff92c-2b1e-4853-b090-fa3c3e96d0de" }, { "name": "Delete a Search Page Interface", "id": "e8ef0077-d80f-43b0-b99b-443dea2cc388", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId" ], "variable": [ { "id": "19fd9a94-ce9d-407c-be7f-db33f61cf324", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "9900c700-5efe-4460-bdd5-53b336930d7c", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target search interface." } ] }, "description": "Delete a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "315a5e8b-ff61-42d2-bb30-96472bd59d3f", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-315a5e8b-ff61-42d2-bb30-96472bd59d3f" }, { "id": "6f3e090a-f15b-4809-9cf6-0aa2c4644caa", "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces", ":interfaceId" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-6f3e090a-f15b-4809-9cf6-0aa2c4644caa" } ], "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-e8ef0077-d80f-43b0-b99b-443dea2cc388" } ], "id": "3de8ce95-0ea0-477e-afb5-f9fcc43689af", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-3de8ce95-0ea0-477e-afb5-f9fcc43689af" }, { "name": "Get All Search Page Interfaces", "id": "54b65f69-fb95-4f56-9b73-025860b663b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces?filter=&order=desc&page=&perPage=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces" ], "query": [ { "description": "A substring that must appear in a search interface configuration name for this configuration to appear in results.", "key": "filter", "value": "" }, { "description": "The sort direction of the results.
Possible values:
- `asc`: ascending order
- `desc`: descending order", "key": "order", "value": "desc" }, { "description": "The 0-based number of the page of configurations to list.", "key": "page", "value": "" }, { "description": "The maximum number of configurations to include per page.", "key": "perPage", "value": "" } ], "variable": [ { "id": "7d160bf9-b9d3-4df8-adbf-93fdf88b1994", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." } ] }, "description": "Get all search page interfaces in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "ee3b213c-a839-4184-83f9-e11b7991cb79", "name": "Ok", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces?filter=&order=desc&page=&perPage=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces" ], "query": [ { "description": "A substring that must appear in a search interface configuration name for this configuration to appear in results.", "key": "filter", "value": "" }, { "description": "The sort direction of the results.
Possible values:
- `asc`: ascending order
- `desc`: descending order", "key": "order", "value": "desc" }, { "description": "The 0-based number of the page of configurations to list.", "key": "page", "value": "" }, { "description": "The maximum number of configurations to include per page.", "key": "perPage", "value": "" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"date\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"ASC\"\n },\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"ASC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"grid\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"NONE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"LARGE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n },\n \"created\": \"\",\n \"createdBy\": \"\",\n \"updated\": \"\",\n \"updatedBy\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"grid\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"LARGE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n },\n \"created\": \"\",\n \"createdBy\": \"\",\n \"updated\": \"\",\n \"updatedBy\": \"\"\n }\n]", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-ee3b213c-a839-4184-83f9-e11b7991cb79" } ], "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-54b65f69-fb95-4f56-9b73-025860b663b3" }, { "name": "Create a Search Page Interface", "id": "30586db7-58ea-46f6-81b6-c04c58befc2b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"relevancy\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"ASC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"list\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"SMALL\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces" ], "variable": [ { "id": "c89a376d-3b8b-4edf-8c49-def74427a8f8", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." } ] }, "description": "Create a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "46f953ed-480a-4992-bcc8-e55e64721aa1", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"relevancy\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"ASC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"list\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"SMALL\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/searchpage/v1/interfaces", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "searchpage", "v1", "interfaces" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"field\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"grid\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"MEDIUM\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"LARGE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n },\n \"created\": \"\",\n \"createdBy\": \"\",\n \"updated\": \"\",\n \"updatedBy\": \"\"\n}", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-46f953ed-480a-4992-bcc8-e55e64721aa1" } ], "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-30586db7-58ea-46f6-81b6-c04c58befc2b" } ], "id": "dc65895f-9419-487b-8e9d-502cadb0c616", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-dc65895f-9419-487b-8e9d-502cadb0c616" } ], "id": "86cfe82f-4f6c-4f7c-bd2e-9a36827d474e", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-86cfe82f-4f6c-4f7c-bd2e-9a36827d474e" } ], "id": "57a0ff34-f86e-4da0-9d2b-af794d9d4e6c", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-57a0ff34-f86e-4da0-9d2b-af794d9d4e6c" } ], "id": "58e8bef8-1203-4bce-800c-261c27036915", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-58e8bef8-1203-4bce-800c-261c27036915" } ], "id": "78effe47-1e93-456c-84e7-210db7ab4fe4", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-78effe47-1e93-456c-84e7-210db7ab4fe4" } ], "id": "bac9138a-fde2-4492-a602-68a99f3548fe", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-bac9138a-fde2-4492-a602-68a99f3548fe" }, { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "searchpage", "item": [ { "name": "v1", "item": [ { "name": "projects", "item": [ { "name": "interfaces", "item": [ { "name": "Get Project Search Page Interfaces", "id": "bae5f9c4-9272-4ae1-8e49-63f76040edc6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/searchpage/v1/projects/interfaces?filter=&order=desc&page=&perPage=&projectId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "searchpage", "v1", "projects", "interfaces" ], "query": [ { "description": "A substring that must appear in a search interface configuration name for this configuration to appear in results.", "key": "filter", "value": "" }, { "description": "The sort direction of the results.
Possible values:
- `asc`: ascending order
- `desc`: descending order", "key": "order", "value": "desc" }, { "description": "The 0-based number of the page of configurations to list.", "key": "page", "value": "" }, { "description": "The maximum number of configurations to include per page.", "key": "perPage", "value": "" }, { "description": "The id of the project to which the resource belongs.", "key": "projectId", "value": "" } ], "variable": [ { "id": "a019978e-c5a0-49a7-bc5c-670bbb1f9a19", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." } ] }, "description": "Get all search page interfaces in a [Coveo organization](https://docs.coveo.com/en/185/) and a [project](https://docs.coveo.com/en/n7ef0517/manage-an-organization/manage-projects)." }, "response": [ { "id": "acecd4ce-a224-4527-bff3-06c8d6f4f954", "name": "Ok", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/searchpage/v1/projects/interfaces?filter=&order=desc&page=&perPage=&projectId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "searchpage", "v1", "projects", "interfaces" ], "query": [ { "description": "A substring that must appear in a search interface configuration name for this configuration to appear in results.", "key": "filter", "value": "" }, { "description": "The sort direction of the results.
Possible values:
- `asc`: ascending order
- `desc`: descending order", "key": "order", "value": "desc" }, { "description": "The 0-based number of the page of configurations to list.", "key": "page", "value": "" }, { "description": "The maximum number of configurations to include per page.", "key": "perPage", "value": "" }, { "description": "The id of the project to which the resource belongs.", "key": "projectId", "value": "" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"relevancy\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"ASC\"\n },\n {\n \"by\": \"date\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"grid\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"LARGE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"NONE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n },\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"sortCriteria\": [\n {\n \"by\": \"date\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n },\n {\n \"by\": \"date\",\n \"label\": \"\",\n \"field\": \"\",\n \"order\": \"DESC\"\n }\n ],\n \"accesses\": {\n \"users\": [\n \"\",\n \"\"\n ],\n \"domains\": [\n \"\",\n \"\"\n ],\n \"sharingLinkEnabled\": \"\",\n \"sharingDomainEnabled\": \"\"\n },\n \"layout\": \"list\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"SMALL\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"badges\": [\n {\n \"field\": \"\",\n \"color\": \"\"\n },\n {\n \"field\": \"\",\n \"color\": \"\"\n }\n ],\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n },\n {\n \"conditionType\": \"\",\n \"field\": \"\",\n \"values\": \"\"\n }\n ],\n \"imageSize\": \"NONE\",\n \"descriptionEnabled\": \"\",\n \"resultActions\": {\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"style\": {\n \"fontFamily\": \"\",\n \"colors\": {\n \"accent1\": \"\",\n \"accent2\": \"\",\n \"background\": \"\",\n \"titles\": \"\",\n \"normalText\": \"\",\n \"navigationBackground\": \"\"\n }\n },\n \"settings\": {\n \"targetSelector\": \"\",\n \"querySuggestions\": {\n \"enabled\": \"\"\n },\n \"queryHistory\": {\n \"enabled\": \"\"\n },\n \"smartSnippets\": {\n \"enabled\": \"\"\n },\n \"peopleAlsoAsk\": {\n \"enabled\": \"\"\n },\n \"genQA\": {\n \"enabled\": \"\"\n },\n \"agent\": {\n \"enabled\": false\n }\n },\n \"projectIds\": [\n \"\",\n \"\"\n ]\n }\n]", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-acecd4ce-a224-4527-bff3-06c8d6f4f954" } ], "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-bae5f9c4-9272-4ae1-8e49-63f76040edc6" } ], "id": "53c349b9-a097-4774-9d88-462e654697c4", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-53c349b9-a097-4774-9d88-462e654697c4" } ], "id": "98cb65e6-0799-4d2f-9c38-808e88d7ea0c", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-98cb65e6-0799-4d2f-9c38-808e88d7ea0c" } ], "id": "5803209a-b1b1-4fc6-bdfd-e24ce7c04ac9", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-5803209a-b1b1-4fc6-bdfd-e24ce7c04ac9" } ], "id": "1c374d12-991e-471f-8e3d-73a9fbb29242", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-1c374d12-991e-471f-8e3d-73a9fbb29242" } ], "id": "a8873a19-0ca8-455a-b4ec-e01e7c952d06", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-a8873a19-0ca8-455a-b4ec-e01e7c952d06" } ], "id": "5ba7f53c-f383-4a31-97c1-6874f8175b52", "createdAt": "2026-07-28T01:31:38.000Z", "updatedAt": "2026-07-28T01:31:38.000Z", "uid": "35240-5ba7f53c-f383-4a31-97c1-6874f8175b52" } ], "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" } ] }