{ "info": { "_postman_id": "9800a8d4-721c-4db8-ad2b-aa7146c9c6a1", "name": "Coveo Activity Activities In-App 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:28:44.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "lastUpdatedBy": "35240", "uid": "35240-9800a8d4-721c-4db8-ad2b-aa7146c9c6a1" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationID}", "item": [ { "name": "pages", "item": [ { "name": "inappwidget", "item": [ { "name": "{pageID}", "item": [ { "name": "Update InAppWidget", "id": "27b486f9-fc7c-496a-88f4-0fa667960f73", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidget/:pageID", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidget", ":pageID" ], "variable": [ { "id": "37f07220-e7d0-4762-acb6-af5592501c56", "key": "organizationID", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')." }, { "id": "b668376f-9716-4624-9250-0c701a2621b7", "key": "pageID", "value": "", "description": "(Required) The unique identifier of the search page whose corresponding InAppWidget should be updated (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')." } ] }, "description": "Updates an InAppWidget in a [Coveo Cloud organization](https://docs.coveo.com/en/185).

**Required privilege:** Search Pages - Edit
Privilege required```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"EDIT\", \"targetId\": \"*\" }```
" }, "response": [ { "id": "b9631c49-d7a3-468e-aa03-bbf148020c65", "name": "Updated successfully", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidget/:pageID", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidget", ":pageID" ], "variable": [ { "key": "organizationID" }, { "key": "pageID" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-b9631c49-d7a3-468e-aa03-bbf148020c65" }, { "id": "7b77628e-4721-4279-be87-b75bb8f556dc", "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidget/:pageID", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidget", ":pageID" ], "variable": [ { "key": "organizationID" }, { "key": "pageID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-7b77628e-4721-4279-be87-b75bb8f556dc" }, { "id": "709f8116-e8f3-4fab-8db5-f847b162bf15", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidget/:pageID", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidget", ":pageID" ], "variable": [ { "key": "organizationID" }, { "key": "pageID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-709f8116-e8f3-4fab-8db5-f847b162bf15" }, { "id": "edd39a1f-47de-4685-a918-d274d0041d48", "name": "Internal Server Error", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidget/:pageID", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidget", ":pageID" ], "variable": [ { "key": "organizationID" }, { "key": "pageID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-edd39a1f-47de-4685-a918-d274d0041d48" } ], "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-27b486f9-fc7c-496a-88f4-0fa667960f73" } ], "id": "c73f82d1-86fb-4e18-af83-e859d6482a79", "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-c73f82d1-86fb-4e18-af83-e859d6482a79" }, { "name": "Create InAppWidget", "id": "8fa97227-4ac1-4df8-ac55-a58541d0316e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidget", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidget" ], "variable": [ { "id": "86502969-591f-4b4f-9bf8-57941be3b0aa", "key": "organizationID", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')." } ] }, "description": "Creates an InAppWidget in a [Coveo Cloud organization](https://docs.coveo.com/en/185).

**Required privilege:** Search Pages - Create
Privilege required```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"CREATE\", \"targetId\": \"*\" }```
" }, "response": [ { "id": "c749fed6-568e-4bdf-a6f5-618709d80975", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidget", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidget" ], "variable": [ { "key": "organizationID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-c749fed6-568e-4bdf-a6f5-618709d80975" }, { "id": "d233017a-6d1b-4fc4-abeb-6e231a0f5057", "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/pages/inappwidget", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidget" ], "variable": [ { "key": "organizationID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-d233017a-6d1b-4fc4-abeb-6e231a0f5057" }, { "id": "a0e57e03-2d46-4fc0-a6ef-a324a2d51fd0", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidget", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidget" ], "variable": [ { "key": "organizationID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-a0e57e03-2d46-4fc0-a6ef-a324a2d51fd0" }, { "id": "649f3bce-cf54-4a86-8991-04b67adfad4a", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidget", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidget" ], "variable": [ { "key": "organizationID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-649f3bce-cf54-4a86-8991-04b67adfad4a" } ], "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-8fa97227-4ac1-4df8-ac55-a58541d0316e" } ], "id": "fada5076-09ee-4b83-bc60-74a14566be4c", "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-fada5076-09ee-4b83-bc60-74a14566be4c" }, { "name": "inappwidgets", "item": [ { "name": "ids", "item": [ { "name": "List InAppWidgets by Ids", "id": "b1afb04e-8dc6-47b1-938d-9b6d437222de", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets/ids", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets", "ids" ], "variable": [ { "id": "781c8e15-3814-4179-99b7-b974dae431b1", "key": "organizationID", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/) (e.g., 'mycoveocloudv2organizationg8tp8wu3')." } ] }, "description": "lists InAppWidgets by ids in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).

**Required privilege:** Search Pages - View
Privilege required```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"VIEW\", \"targetId\": \"*\" }```
" }, "response": [ { "id": "fefd561d-d6d3-4a18-b64f-23fa17c2d1f5", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets/ids", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets", "ids" ], "variable": [ { "key": "organizationID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-fefd561d-d6d3-4a18-b64f-23fa17c2d1f5" }, { "id": "21026c4c-22f2-446d-94b5-b6cb493024f3", "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/pages/inappwidgets/ids", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets", "ids" ], "variable": [ { "key": "organizationID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-21026c4c-22f2-446d-94b5-b6cb493024f3" }, { "id": "8cbd0f34-e515-4ed7-87c0-480597b0560e", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets/ids", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets", "ids" ], "variable": [ { "key": "organizationID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-8cbd0f34-e515-4ed7-87c0-480597b0560e" }, { "id": "d7bab500-ca99-453c-ac26-03f3e478495d", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets/ids", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets", "ids" ], "variable": [ { "key": "organizationID" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-d7bab500-ca99-453c-ac26-03f3e478495d" }, { "id": "54278b82-21ec-4146-bd65-6e33d86e14b7", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets/ids", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets", "ids" ], "variable": [ { "key": "organizationID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-54278b82-21ec-4146-bd65-6e33d86e14b7" } ], "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-b1afb04e-8dc6-47b1-938d-9b6d437222de" } ], "id": "14647dae-602a-4ead-afbc-2d85738b898c", "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-14647dae-602a-4ead-afbc-2d85738b898c" }, { "name": "projectid", "item": [ { "name": "List InAppWidgets by Project ID", "id": "7db94d15-b974-4f51-aec5-84d4f5e5864a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets/projectid?projectid=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets", "projectid" ], "query": [ { "description": "The project id", "key": "projectid", "value": "" } ], "variable": [ { "id": "00eba522-0bed-47c1-a62e-5d6a09c327fe", "key": "organizationID", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/) (e.g., 'mycoveocloudv2organizationg8tp8wu3')." } ] }, "description": "lists InAppWidgets by project id in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).

**Required privilege:** Search Pages - View
Privilege required```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"VIEW\", \"targetId\": \"*\" }```
" }, "response": [ { "id": "7c9f1fc3-f498-4218-97ff-0ced63c1742d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets/projectid?projectid=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets", "projectid" ], "query": [ { "description": "The project id", "key": "projectid", "value": "" } ], "variable": [ { "key": "organizationID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-7c9f1fc3-f498-4218-97ff-0ced63c1742d" }, { "id": "f7299dea-bda5-4c7f-9761-f82a5402116f", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets/projectid?projectid=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets", "projectid" ], "query": [ { "description": "The project id", "key": "projectid", "value": "" } ], "variable": [ { "key": "organizationID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-f7299dea-bda5-4c7f-9761-f82a5402116f" }, { "id": "26e3e6f2-0948-486b-b124-cdd9b7d03d11", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets/projectid?projectid=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets", "projectid" ], "query": [ { "description": "The project id", "key": "projectid", "value": "" } ], "variable": [ { "key": "organizationID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-26e3e6f2-0948-486b-b124-cdd9b7d03d11" }, { "id": "2cd37833-f517-4ae0-a17c-e61ec2b2608f", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets/projectid?projectid=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets", "projectid" ], "query": [ { "description": "The project id", "key": "projectid", "value": "" } ], "variable": [ { "key": "organizationID" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-2cd37833-f517-4ae0-a17c-e61ec2b2608f" }, { "id": "3120044a-8f03-44c9-b79b-ac0012ba49d4", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets/projectid?projectid=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets", "projectid" ], "query": [ { "description": "The project id", "key": "projectid", "value": "" } ], "variable": [ { "key": "organizationID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-3120044a-8f03-44c9-b79b-ac0012ba49d4" } ], "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-7db94d15-b974-4f51-aec5-84d4f5e5864a" } ], "id": "a5f24dd5-a0c7-4cd5-8fa0-92b2e6fd88a0", "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-a5f24dd5-a0c7-4cd5-8fa0-92b2e6fd88a0" }, { "name": "List InAppWidgets", "id": "006bf572-a54b-4986-9e52-e6cad29e4fac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets?name=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets" ], "query": [ { "description": "The 'name' metadata value of the search page whose corresponding InAppWidget should be retrieved (e.g., 'mysearchpage').", "key": "name", "value": "" } ], "variable": [ { "id": "1b6e7134-3394-4f9e-b985-42233ce1e95d", "key": "organizationID", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/) (e.g., 'mycoveocloudv2organizationg8tp8wu3')." } ] }, "description": "Lists all InAppWidgets in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).

**Required privilege:** Search Pages - View
Privilege required```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"VIEW\", \"targetId\": \"*\" }```
" }, "response": [ { "id": "9c64c54e-9f02-44c8-b28f-24b96644c015", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets?name=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets" ], "query": [ { "description": "The 'name' metadata value of the search page whose corresponding InAppWidget should be retrieved (e.g., 'mysearchpage').", "key": "name", "value": "" } ], "variable": [ { "key": "organizationID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-9c64c54e-9f02-44c8-b28f-24b96644c015" }, { "id": "4db396e8-e8dc-4ecc-b14b-cb61ba9902d2", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets?name=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets" ], "query": [ { "description": "The 'name' metadata value of the search page whose corresponding InAppWidget should be retrieved (e.g., 'mysearchpage').", "key": "name", "value": "" } ], "variable": [ { "key": "organizationID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-4db396e8-e8dc-4ecc-b14b-cb61ba9902d2" }, { "id": "b118ada4-df87-459b-be22-376b56c7d426", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets?name=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets" ], "query": [ { "description": "The 'name' metadata value of the search page whose corresponding InAppWidget should be retrieved (e.g., 'mysearchpage').", "key": "name", "value": "" } ], "variable": [ { "key": "organizationID" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-b118ada4-df87-459b-be22-376b56c7d426" }, { "id": "d2009332-aa61-43a3-a0ae-820de1aaf5f2", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets?name=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets" ], "query": [ { "description": "The 'name' metadata value of the search page whose corresponding InAppWidget should be retrieved (e.g., 'mysearchpage').", "key": "name", "value": "" } ], "variable": [ { "key": "organizationID" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-d2009332-aa61-43a3-a0ae-820de1aaf5f2" }, { "id": "5c334e57-854e-4368-ad73-abf8e5c01644", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/inappwidgets?name=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", "inappwidgets" ], "query": [ { "description": "The 'name' metadata value of the search page whose corresponding InAppWidget should be retrieved (e.g., 'mysearchpage').", "key": "name", "value": "" } ], "variable": [ { "key": "organizationID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-5c334e57-854e-4368-ad73-abf8e5c01644" } ], "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-006bf572-a54b-4986-9e52-e6cad29e4fac" } ], "id": "3330c7b3-16e4-4bfa-aae9-bc9360a02263", "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-3330c7b3-16e4-4bfa-aae9-bc9360a02263" }, { "name": "{pageID}", "item": [ { "name": "inappwidget", "item": [ { "name": "loader", "item": [ { "name": "Get InAppWidget Loader", "id": "66423f46-01b7-4331-bf3a-fd5819efbda3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/:pageID/inappwidget/loader?access_token=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", ":pageID", "inappwidget", "loader" ], "query": [ { "description": "

An access token (e.g., [search token](https://docs.coveo.com/en/1346/) or API key) the loader should initialize the InAppWidget with.

If provided, this token:

  • Must grant the **Allowed** [access level](https://docs.coveo.com/en/2818/) on the **Execute Queries** [domain](https://docs.coveo.com/en/2819/), and the **Push** access level on the **Analytics Data** domain in the target [organization](https://docs.coveo.com/en/185/).
  • Will completely override the search token configuration specified the InAppWidget.
", "key": "access_token", "value": "" } ], "variable": [ { "id": "a414c6da-620e-4481-9aad-fdd12433187c", "key": "organizationID", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) whose InAppWidget loader should be retrieved (e.g., 'mycoveocloudv2organizationg8tp8wu3')." }, { "id": "78bb3c4b-b02f-4771-b703-0110661f9622", "key": "pageID", "value": "", "description": "(Required) The unique identifier of the search page whose corresponding InAppWidget loader should be retrieved (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')." } ] }, "description": "Retrieves the JavaScript code that can initialize a specific InAppWidget configured in a [Coveo Cloud organization](https://docs.coveo.com/en/185).

**Required privilege:** None
" }, "response": [ { "id": "e84874e2-ca33-435e-a31a-bfdf2c0f68b9", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/:pageID/inappwidget/loader?access_token=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", ":pageID", "inappwidget", "loader" ], "query": [ { "description": "

An access token (e.g., [search token](https://docs.coveo.com/en/1346/) or API key) the loader should initialize the InAppWidget with.

If provided, this token:

  • Must grant the **Allowed** [access level](https://docs.coveo.com/en/2818/) on the **Execute Queries** [domain](https://docs.coveo.com/en/2819/), and the **Push** access level on the **Analytics Data** domain in the target [organization](https://docs.coveo.com/en/185/).
  • Will completely override the search token configuration specified the InAppWidget.
", "key": "access_token", "value": "" } ], "variable": [ { "key": "organizationID" }, { "key": "pageID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-e84874e2-ca33-435e-a31a-bfdf2c0f68b9" }, { "id": "b6a201cc-2e9a-4e84-ab7e-8e53818fc4f2", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/:pageID/inappwidget/loader?access_token=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", ":pageID", "inappwidget", "loader" ], "query": [ { "description": "

An access token (e.g., [search token](https://docs.coveo.com/en/1346/) or API key) the loader should initialize the InAppWidget with.

If provided, this token:

  • Must grant the **Allowed** [access level](https://docs.coveo.com/en/2818/) on the **Execute Queries** [domain](https://docs.coveo.com/en/2819/), and the **Push** access level on the **Analytics Data** domain in the target [organization](https://docs.coveo.com/en/185/).
  • Will completely override the search token configuration specified the InAppWidget.
", "key": "access_token", "value": "" } ], "variable": [ { "key": "organizationID" }, { "key": "pageID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-b6a201cc-2e9a-4e84-ab7e-8e53818fc4f2" }, { "id": "7086fee6-58a0-497e-b4f5-707e9c3f0c2a", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/:pageID/inappwidget/loader?access_token=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", ":pageID", "inappwidget", "loader" ], "query": [ { "description": "

An access token (e.g., [search token](https://docs.coveo.com/en/1346/) or API key) the loader should initialize the InAppWidget with.

If provided, this token:

  • Must grant the **Allowed** [access level](https://docs.coveo.com/en/2818/) on the **Execute Queries** [domain](https://docs.coveo.com/en/2819/), and the **Push** access level on the **Analytics Data** domain in the target [organization](https://docs.coveo.com/en/185/).
  • Will completely override the search token configuration specified the InAppWidget.
", "key": "access_token", "value": "" } ], "variable": [ { "key": "organizationID" }, { "key": "pageID" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-7086fee6-58a0-497e-b4f5-707e9c3f0c2a" }, { "id": "1536268a-7221-4f70-b9e6-2047c5f87fa6", "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/pages/:pageID/inappwidget/loader?access_token=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", ":pageID", "inappwidget", "loader" ], "query": [ { "description": "

An access token (e.g., [search token](https://docs.coveo.com/en/1346/) or API key) the loader should initialize the InAppWidget with.

If provided, this token:

  • Must grant the **Allowed** [access level](https://docs.coveo.com/en/2818/) on the **Execute Queries** [domain](https://docs.coveo.com/en/2819/), and the **Push** access level on the **Analytics Data** domain in the target [organization](https://docs.coveo.com/en/185/).
  • Will completely override the search token configuration specified the InAppWidget.
", "key": "access_token", "value": "" } ], "variable": [ { "key": "organizationID" }, { "key": "pageID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-1536268a-7221-4f70-b9e6-2047c5f87fa6" }, { "id": "2b48385c-67a9-40d9-bdfe-95726271adc2", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationID/pages/:pageID/inappwidget/loader?access_token=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationID", "pages", ":pageID", "inappwidget", "loader" ], "query": [ { "description": "

An access token (e.g., [search token](https://docs.coveo.com/en/1346/) or API key) the loader should initialize the InAppWidget with.

If provided, this token:

  • Must grant the **Allowed** [access level](https://docs.coveo.com/en/2818/) on the **Execute Queries** [domain](https://docs.coveo.com/en/2819/), and the **Push** access level on the **Analytics Data** domain in the target [organization](https://docs.coveo.com/en/185/).
  • Will completely override the search token configuration specified the InAppWidget.
", "key": "access_token", "value": "" } ], "variable": [ { "key": "organizationID" }, { "key": "pageID" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-2b48385c-67a9-40d9-bdfe-95726271adc2" } ], "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-66423f46-01b7-4331-bf3a-fd5819efbda3" } ], "id": "c56766fe-1ac2-4fdc-8972-47c29f84798a", "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-c56766fe-1ac2-4fdc-8972-47c29f84798a" } ], "id": "59ac25f2-f824-4192-9e21-922461b83079", "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-59ac25f2-f824-4192-9e21-922461b83079" } ], "id": "855ad023-13e7-40ca-baff-054043d24acc", "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-855ad023-13e7-40ca-baff-054043d24acc" } ], "id": "ebe9d01e-e9fe-4c7f-a48d-bb7478d8874d", "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-ebe9d01e-e9fe-4c7f-a48d-bb7478d8874d" } ], "id": "ca8f750f-c68d-4b38-9d55-784ed1d2e31a", "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-ca8f750f-c68d-4b38-9d55-784ed1d2e31a" } ], "id": "8309679e-1dc5-4efb-9ef2-27032c89532d", "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-8309679e-1dc5-4efb-9ef2-27032c89532d" } ], "id": "12f59ed2-5ce2-4c86-9f03-a477ab61c759", "createdAt": "2026-07-28T01:28:45.000Z", "updatedAt": "2026-07-28T01:28:45.000Z", "uid": "35240-12f59ed2-5ce2-4c86-9f03-a477ab61c759" } ], "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" } ] }