{ "info": { "_postman_id": "b1ddb35f-42b7-4802-83c0-852ea30b3e10", "name": "Coveo Activity Activities Users API - Version 14 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:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "lastUpdatedBy": "35240", "uid": "35240-b1ddb35f-42b7-4802-83c0-852ea30b3e10" }, "item": [ { "name": "v14", "item": [ { "name": "users", "item": [ { "name": "{userId}", "item": [ { "name": "filters", "item": [ { "name": "Get the Data Level Filters That Apply to a User", "id": "c2c8689b-2d66-45af-bb28-1fd56b7de085", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/users/:userId/filters?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "users", ":userId", "filters" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "07a8b9c3-8a32-4390-9e33-6251ca57ad62", "key": "userId", "value": "", "description": "(Required) The unique identifier of a user." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "4600aece-487e-4196-bddf-69dadc99f3c7", "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}}/v14/users/:userId/filters?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "users", ":userId", "filters" ], "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 \"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:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-4600aece-487e-4196-bddf-69dadc99f3c7" } ], "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-c2c8689b-2d66-45af-bb28-1fd56b7de085" }, { "name": "Set the Filters That Will Be Applied to a User Query", "id": "39062ce1-f9d4-487a-93e0-ac2a517db76b", "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}}/v14/users/:userId/filters?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "users", ":userId", "filters" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "3491847e-0870-40e5-ad26-9a7c8b190ac6", "key": "userId", "value": "", "description": "(Required) The unique identifier of a user." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "f002f28f-d063-418a-a502-45b24e4d1bf5", "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}}/v14/users/:userId/filters?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-f002f28f-d063-418a-a502-45b24e4d1bf5" } ], "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-39062ce1-f9d4-487a-93e0-ac2a517db76b" } ], "id": "7cb655e6-3541-4707-9ee0-6c0c4172ff21", "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-7cb655e6-3541-4707-9ee0-6c0c4172ff21" }, { "name": "reports", "item": [ { "name": "Get the Reports That a User Can Access", "id": "51a3cea3-efb1-4569-b236-9fb32613e126", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/users/:userId/reports?org=&includeConfig=true", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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" } ], "variable": [ { "id": "96920726-dac5-4ee4-a8cd-6f994a679821", "key": "userId", "value": "", "description": "(Required) The unique identifier of a user." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "f92f4e51-8f6c-4c02-bb80-1a4751095ac7", "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}}/v14/users/:userId/reports?org=&includeConfig=true", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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" } ], "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 \"do_421\": {},\n \"in_0f3\": {}\n },\n \"allAnalyticsViewer\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"account\": \"\",\n \"displayName\": \"\",\n \"type\": \"\",\n \"configuration\": {\n \"culpa_6\": {},\n \"consectetur6\": {},\n \"enim53\": {},\n \"do11e\": {},\n \"aliquip15\": {}\n },\n \"allAnalyticsViewer\": \"\",\n \"filters\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-f92f4e51-8f6c-4c02-bb80-1a4751095ac7" } ], "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-51a3cea3-efb1-4569-b236-9fb32613e126" }, { "name": "Set Which Reports a User Can Access", "id": "0c193446-a803-46df-9bf9-3b62fe768839", "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}}/v14/users/:userId/reports?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "users", ":userId", "reports" ], "query": [ { "description": "The unique identifier of a user.", "key": "org", "value": "" } ], "variable": [ { "id": "f8654fcb-713b-4817-b5e1-b9c306a7733c", "key": "userId", "value": "", "description": "(Required) The unique identifier of a user." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "2757bed1-c000-471f-a816-064cdb3e0afd", "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}}/v14/users/:userId/reports?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-2757bed1-c000-471f-a816-064cdb3e0afd" } ], "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-0c193446-a803-46df-9bf9-3b62fe768839" } ], "id": "0115fb44-49dc-4fb8-90e2-4920ffcb7f4e", "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-0115fb44-49dc-4fb8-90e2-4920ffcb7f4e" }, { "name": "Get a User", "id": "e18fdd1b-0430-4239-a508-e61e50c1b4f0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/users/:userId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "users", ":userId" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ], "variable": [ { "id": "d2724324-8c1f-4842-9a99-4c67578519c4", "key": "userId", "value": "", "description": "(Required) The unique identifier of a user." } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "a784fa96-f38b-4724-9ae9-79ddf20843c0", "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}}/v14/users/:userId?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-a784fa96-f38b-4724-9ae9-79ddf20843c0" } ], "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-e18fdd1b-0430-4239-a508-e61e50c1b4f0" } ], "id": "e9eee5c8-5545-4cce-a127-a97d921764e1", "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-e9eee5c8-5545-4cce-a127-a97d921764e1" }, { "name": "monitoring", "item": [ { "name": "health", "item": [ { "name": "Health Check for the Users Service", "id": "0a9741b6-f575-4d73-9825-d4f165a2f87d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/users/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v14", "users", "monitoring", "health" ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "ff9fb881-58fb-4edb-b326-85a5a713ae99", "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}}/v14/users/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-ff9fb881-58fb-4edb-b326-85a5a713ae99" } ], "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-0a9741b6-f575-4d73-9825-d4f165a2f87d" } ], "id": "9a98d147-8c2e-469f-a253-a31e85568a3f", "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-9a98d147-8c2e-469f-a253-a31e85568a3f" } ], "id": "37f0c5c4-052c-42dd-af2e-81aeef4b619e", "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-37f0c5c4-052c-42dd-af2e-81aeef4b619e" }, { "name": "status", "item": [ { "name": "Get the Users Service Status", "id": "fc7156cd-fc3c-42ce-b7a1-6693973aa5c3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/users/status", "host": [ "{{baseUrl}}" ], "path": [ "v14", "users", "status" ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "2b6a7830-ca25-4d49-9837-5708053b4f72", "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}}/v14/users/status", "host": [ "{{baseUrl}}" ], "path": [ "v14", "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:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-2b6a7830-ca25-4d49-9837-5708053b4f72" } ], "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-fc7156cd-fc3c-42ce-b7a1-6693973aa5c3" } ], "id": "9401242f-fb20-4888-a9f9-44655b43c65d", "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-9401242f-fb20-4888-a9f9-44655b43c65d" } ], "id": "588ec234-758c-427b-9c8c-83b20c1a7e45", "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-588ec234-758c-427b-9c8c-83b20c1a7e45" } ], "id": "5b4cb055-0ff5-4000-9e3c-6246e0c4ce1f", "createdAt": "2026-07-28T01:33:29.000Z", "updatedAt": "2026-07-28T01:33:29.000Z", "uid": "35240-5b4cb055-0ff5-4000-9e3c-6246e0c4ce1f" } ], "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" } ] }