{ "info": { "_postman_id": "34104abf-f65d-4a59-957d-1728ad6ff8ec", "name": "Coveo Activity Activities Groups API - Version 15 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:40.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "lastUpdatedBy": "35240", "uid": "35240-34104abf-f65d-4a59-957d-1728ad6ff8ec" }, "item": [ { "name": "v15", "item": [ { "name": "groups", "item": [ { "name": "{groupId}", "item": [ { "name": "filters", "item": [ { "name": "Gets the Data Level Filters That Apply to the Specified Group.", "id": "38dc2293-4e44-4cbc-8422-bbfa92de4616", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/groups/:groupId/filters?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups", ":groupId", "filters" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "323eea7f-282e-45da-bb26-c51f18b803c5", "key": "groupId", "value": "", "description": "(Required) The unique identifier of a group." } ] } }, "response": [ { "id": "76852028-1bb1-477b-b815-621602c74cfa", "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}}/v15/groups/:groupId/filters?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups", ":groupId", "filters" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "groupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"filters\": [\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"account\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"account\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-76852028-1bb1-477b-b815-621602c74cfa" } ], "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-38dc2293-4e44-4cbc-8422-bbfa92de4616" }, { "name": "Set the Filters That Will Be Applied to the Specified Group's Query", "id": "79b934da-1f3c-4a0e-b56d-1133688fff5d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/groups/:groupId/filters?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups", ":groupId", "filters" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "b162f278-2077-4974-84a6-066b7e30856b", "key": "groupId", "value": "", "description": "(Required) The unique identifier of a group." } ] } }, "response": [ { "id": "90c97e1e-49ac-47e3-aa97-46bfcfb8ba70", "name": "No content", "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 \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/groups/:groupId/filters?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups", ":groupId", "filters" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "groupId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-90c97e1e-49ac-47e3-aa97-46bfcfb8ba70" } ], "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-79b934da-1f3c-4a0e-b56d-1133688fff5d" } ], "id": "807841e2-7c47-4c3e-a84e-1cd5b931e8f3", "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-807841e2-7c47-4c3e-a84e-1cd5b931e8f3" }, { "name": "reports", "item": [ { "name": "Gets the Reports That the Specified Group Can Access.", "id": "3a008821-8858-4dce-97cf-060133d268f4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/groups/:groupId/reports?org=&includeConfig=true", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups", ":groupId", "reports" ], "query": [ { "description": "The unique identifier of a user.", "key": "org", "value": "" }, { "description": "Whether to include the detailed configuration of the report in the response.", "key": "includeConfig", "value": "true" } ], "variable": [ { "id": "5b934d65-ad9e-43d6-95f7-d8c718a714f9", "key": "groupId", "value": "", "description": "(Required) The unique identifier of a group." } ] } }, "response": [ { "id": "db70186b-8a9a-421e-a9d6-3fd1df84e976", "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}}/v15/groups/:groupId/reports?org=&includeConfig=true", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups", ":groupId", "reports" ], "query": [ { "description": "The unique identifier of a user.", "key": "org", "value": "" }, { "description": "Whether to include the detailed configuration of the report in the response.", "key": "includeConfig", "value": "true" } ], "variable": [ { "key": "groupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"reports\": [\n {\n \"id\": \"\",\n \"account\": \"\",\n \"displayName\": \"\",\n \"type\": \"\",\n \"configuration\": {\n \"sint4c\": {},\n \"officia7_\": {}\n },\n \"allAnalyticsViewer\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"account\": \"\",\n \"displayName\": \"\",\n \"type\": \"\",\n \"configuration\": {\n \"reprehenderitbcc\": {},\n \"elit0c9\": {}\n },\n \"allAnalyticsViewer\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-db70186b-8a9a-421e-a9d6-3fd1df84e976" } ], "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-3a008821-8858-4dce-97cf-060133d268f4" }, { "name": "Set Which Reports the Specified Group Can Access.", "id": "9c66da62-a545-45bf-8107-b9a4f2d106e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v15/groups/:groupId/reports?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups", ":groupId", "reports" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "0b613253-feed-4a98-978b-09938d61937e", "key": "groupId", "value": "", "description": "(Required) The unique identifier of a group." } ] } }, "response": [ { "id": "0c7a9a74-6007-4289-9058-2a7b1a00f750", "name": "No content", "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}}/v15/groups/:groupId/reports?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups", ":groupId", "reports" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "groupId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-0c7a9a74-6007-4289-9058-2a7b1a00f750" } ], "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-9c66da62-a545-45bf-8107-b9a4f2d106e3" } ], "id": "035e4835-c265-420d-b4a2-8b3fbf8008e3", "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-035e4835-c265-420d-b4a2-8b3fbf8008e3" }, { "name": "Get a Group.", "id": "b0af8a44-5692-409c-8682-906c2fb4735c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/groups/:groupId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups", ":groupId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "fe39d085-ff30-4f36-bdd7-f147f4db5ad1", "key": "groupId", "value": "", "description": "(Required) The unique identifier of a group." } ] } }, "response": [ { "id": "6a38c0ca-9d4a-4310-baff-a208f0ca327b", "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}}/v15/groups/:groupId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups", ":groupId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "groupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"groupId\": \"\",\n \"account\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ],\n \"reports\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-6a38c0ca-9d4a-4310-baff-a208f0ca327b" } ], "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-b0af8a44-5692-409c-8682-906c2fb4735c" } ], "id": "1fac0f8e-d174-4152-a68e-8f3db317309c", "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-1fac0f8e-d174-4152-a68e-8f3db317309c" }, { "name": "monitoring", "item": [ { "name": "health", "item": [ { "name": "Health Check for the Groups Service", "id": "96e43b59-90bc-48fb-9eda-65bde05c4f09", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/groups/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups", "monitoring", "health" ] } }, "response": [ { "id": "046cf744-d44e-4015-8d2f-63d7f49354df", "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}}/v15/groups/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups", "monitoring", "health" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-046cf744-d44e-4015-8d2f-63d7f49354df" } ], "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-96e43b59-90bc-48fb-9eda-65bde05c4f09" } ], "id": "a5f56b73-084d-4ab1-89a5-83e45218d4f6", "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-a5f56b73-084d-4ab1-89a5-83e45218d4f6" } ], "id": "5269adcb-8b0e-47f4-8300-6b344a547082", "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-5269adcb-8b0e-47f4-8300-6b344a547082" }, { "name": "status", "item": [ { "name": "Get the Groups Service Status", "id": "681313d0-0436-4762-a5f7-e86c87e964b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/groups/status", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups", "status" ] } }, "response": [ { "id": "658c0d2c-ec09-4c13-b2f0-9047ee513306", "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}}/v15/groups/status", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-658c0d2c-ec09-4c13-b2f0-9047ee513306" } ], "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-681313d0-0436-4762-a5f7-e86c87e964b3" } ], "id": "bc32aeed-6230-4834-9fa2-87a401028805", "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-bc32aeed-6230-4834-9fa2-87a401028805" }, { "name": "Gets All Groups for Account.", "id": "c751f475-69dd-4b0f-a186-69814aeb7f00", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/groups?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups" ], "query": [ { "description": "(Required) The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "response": [ { "id": "f5e3f94b-0260-455c-b376-effd44d35c5e", "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}}/v15/groups?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "groups" ], "query": [ { "description": "(Required) The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"groups\": [\n {\n \"groupId\": \"\",\n \"account\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ],\n \"reports\": [\n \"\",\n \"\"\n ]\n },\n {\n \"groupId\": \"\",\n \"account\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ],\n \"reports\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-f5e3f94b-0260-455c-b376-effd44d35c5e" } ], "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-c751f475-69dd-4b0f-a186-69814aeb7f00" } ], "id": "d402d598-dd80-454a-9f9a-3a91ab086f12", "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-d402d598-dd80-454a-9f9a-3a91ab086f12" } ], "id": "530dc373-0a65-4022-a1ea-a1529503f343", "createdAt": "2026-07-28T01:28:41.000Z", "updatedAt": "2026-07-28T01:28:41.000Z", "uid": "35240-530dc373-0a65-4022-a1ea-a1529503f343" } ], "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" } ] }