{ "info": { "_postman_id": "c60cba7d-5eaf-4ed2-b52e-c4188b295282", "name": "Coveo Activity Activities Users 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:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "lastUpdatedBy": "35240", "uid": "35240-c60cba7d-5eaf-4ed2-b52e-c4188b295282" }, "item": [ { "name": "v15", "item": [ { "name": "users", "item": [ { "name": "{userId}", "item": [ { "name": "filters", "item": [ { "name": "Get the Data Level Filters That Apply to a User", "id": "d813a630-75ee-47e0-9e47-e7316231ad86", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/users/:userId/filters?org=&includeGroups=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "users", ":userId", "filters" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "Whether to include the values inherited from a user's groups in the response.", "key": "includeGroups", "value": "false" } ], "variable": [ { "id": "0ba15d45-58da-4e21-b389-71fc9bdb384c", "key": "userId", "value": "", "description": "(Required) The unique identifier of a user." } ] } }, "response": [ { "id": "7108ccb7-4fbb-46f9-8f13-f39dce69271f", "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/users/:userId/filters?org=&includeGroups=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "users", ":userId", "filters" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "Whether to include the values inherited from a user's groups in the response.", "key": "includeGroups", "value": "false" } ], "variable": [ { "key": "userId" } ] } }, "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:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-7108ccb7-4fbb-46f9-8f13-f39dce69271f" } ], "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-d813a630-75ee-47e0-9e47-e7316231ad86" }, { "name": "Set the Filters That Will Be Applied to a User Query", "id": "adb048be-e67c-4183-bf30-c4af627157cc", "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/users/:userId/filters?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "users", ":userId", "filters" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "38b715a9-cfd6-4163-9ae0-e93156c7e02f", "key": "userId", "value": "", "description": "(Required) The unique identifier of a user." } ] } }, "response": [ { "id": "50f64df4-eeac-4665-ba60-a60ba0183c69", "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/users/:userId/filters?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "users", ":userId", "filters" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "userId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-50f64df4-eeac-4665-ba60-a60ba0183c69" } ], "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-adb048be-e67c-4183-bf30-c4af627157cc" } ], "id": "f3126515-34be-4c2e-8073-334efcf09508", "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-f3126515-34be-4c2e-8073-334efcf09508" }, { "name": "reports", "item": [ { "name": "Get the Reports That a User Can Access", "id": "148bdfd2-d2c4-4407-a49d-2008d584581f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/users/:userId/reports?org=&includeConfig=true&includeGroups=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "users", ":userId", "reports" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "Whether to include the detailed configuration of the report in the response.", "key": "includeConfig", "value": "true" }, { "description": "Whether to include the values inherited from a user's groups in the response.", "key": "includeGroups", "value": "false" } ], "variable": [ { "id": "6cfe3283-48f6-447a-a2c3-cfc30259fa58", "key": "userId", "value": "", "description": "(Required) The unique identifier of a user." } ] } }, "response": [ { "id": "83fa7772-41b3-43e1-bde5-8ef09ba57cd2", "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/users/:userId/reports?org=&includeConfig=true&includeGroups=false", "host": [ "{{baseUrl}}" ], "path": [ "v15", "users", ":userId", "reports" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" }, { "description": "Whether to include the detailed configuration of the report in the response.", "key": "includeConfig", "value": "true" }, { "description": "Whether to include the values inherited from a user's groups in the response.", "key": "includeGroups", "value": "false" } ], "variable": [ { "key": "userId" } ] } }, "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 \"quisd2\": {},\n \"eu_1c\": {}\n },\n \"allAnalyticsViewer\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"account\": \"\",\n \"displayName\": \"\",\n \"type\": \"\",\n \"configuration\": {\n \"pariaturb5e\": {},\n \"magna5a\": {}\n },\n \"allAnalyticsViewer\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-83fa7772-41b3-43e1-bde5-8ef09ba57cd2" } ], "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-148bdfd2-d2c4-4407-a49d-2008d584581f" }, { "name": "Set Which Reports a User Can Access", "id": "1742d211-622e-47d6-b0ee-6dd633fac61f", "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/users/:userId/reports?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "users", ":userId", "reports" ], "query": [ { "description": "The unique identifier of a user.", "key": "org", "value": "" } ], "variable": [ { "id": "cf171c6f-7dfa-429b-bc75-a2b51b93b443", "key": "userId", "value": "", "description": "(Required) The unique identifier of a user." } ] } }, "response": [ { "id": "02d3db7e-ca26-46e7-94f0-0d2c6b6cbca7", "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/users/:userId/reports?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "users", ":userId", "reports" ], "query": [ { "description": "The unique identifier of a user.", "key": "org", "value": "" } ], "variable": [ { "key": "userId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-02d3db7e-ca26-46e7-94f0-0d2c6b6cbca7" } ], "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-1742d211-622e-47d6-b0ee-6dd633fac61f" } ], "id": "8c857dae-11a6-4051-bb68-4dc761b17548", "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-8c857dae-11a6-4051-bb68-4dc761b17548" }, { "name": "Get a User", "id": "f6223d45-d030-4dc6-8843-ac093d42bc0b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/users/:userId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "users", ":userId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "ec2f2005-7da9-44b3-a307-6e147f4f96b9", "key": "userId", "value": "", "description": "(Required) The unique identifier of a user." } ] } }, "response": [ { "id": "91079b88-6761-49bf-acbd-e9e2fcba0a45", "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/users/:userId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v15", "users", ":userId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "key": "userId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"userId\": \"\",\n \"account\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ],\n \"reports\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-91079b88-6761-49bf-acbd-e9e2fcba0a45" } ], "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-f6223d45-d030-4dc6-8843-ac093d42bc0b" } ], "id": "d053df51-5b94-4d0e-a775-bdd31a814e3a", "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-d053df51-5b94-4d0e-a775-bdd31a814e3a" }, { "name": "monitoring", "item": [ { "name": "health", "item": [ { "name": "Health Check for the Users Service", "id": "ce9a3b09-5bcb-4c86-b629-20b74b4cc44c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/users/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v15", "users", "monitoring", "health" ] } }, "response": [ { "id": "a4990a61-4685-48e5-b3a4-5e9ac32e8613", "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/users/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v15", "users", "monitoring", "health" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-a4990a61-4685-48e5-b3a4-5e9ac32e8613" } ], "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-ce9a3b09-5bcb-4c86-b629-20b74b4cc44c" } ], "id": "fd026688-63fe-4f19-adaa-4a7bef15b68e", "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-fd026688-63fe-4f19-adaa-4a7bef15b68e" } ], "id": "08a0ab3d-3401-4ea3-9f24-6f351ef38b3f", "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-08a0ab3d-3401-4ea3-9f24-6f351ef38b3f" }, { "name": "status", "item": [ { "name": "Get the Users Service Status", "id": "1c1ffdd3-9ff2-4f4c-b7b7-a853f402dff4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v15/users/status", "host": [ "{{baseUrl}}" ], "path": [ "v15", "users", "status" ] } }, "response": [ { "id": "9a158a17-aaec-4e5e-9c74-bd352dca56b0", "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/users/status", "host": [ "{{baseUrl}}" ], "path": [ "v15", "users", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-9a158a17-aaec-4e5e-9c74-bd352dca56b0" } ], "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-1c1ffdd3-9ff2-4f4c-b7b7-a853f402dff4" } ], "id": "1ee8614d-a52a-4cc0-8575-0c347a528b52", "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-1ee8614d-a52a-4cc0-8575-0c347a528b52" } ], "id": "e925ec8e-2abc-43e5-8884-5ec4ead6a9c3", "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-e925ec8e-2abc-43e5-8884-5ec4ead6a9c3" } ], "id": "4460f70e-d9cd-4638-8f7f-44bc463dfa74", "createdAt": "2026-07-28T01:33:30.000Z", "updatedAt": "2026-07-28T01:33:30.000Z", "uid": "35240-4460f70e-d9cd-4638-8f7f-44bc463dfa74" } ], "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" } ] }