{ "opencollection": "1.0.0", "info": { "name": "Helpcenter User API", "version": "1.0.0" }, "items": [ { "info": { "name": "User", "type": "folder" }, "items": [ { "info": { "name": "Get User Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/users/:userId", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "This API fetches the details of a particular help center user." }, { "info": { "name": "Update User Details", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/users/:userId", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API helps update the details of a particular help center user. " }, { "info": { "name": "Associate Groups To Users", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/users/:userId/groups/associate", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API adds a user to the groups specified." }, { "info": { "name": "Get User Labels", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/users/:userId/labels", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "This API lists a particular number of labels associated with a user, based on the limit defined." }, { "info": { "name": "Remove Labels From User", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/users/:userId/labels/remove", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "This API removes the labels you specify from a particular user." }, { "info": { "name": "Delete Groups From Users", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/users/:userId/groups/dissociate", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "This API removes a user from the groups specified." }, { "info": { "name": "Delete End User", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/users/:userId/anonymize", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API permanently deletes all identifying information about a user from your help center." }, { "info": { "name": "Get Users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/users", "params": [ { "name": "include", "value": "", "type": "query", "description": "Additional information related to the user. Value allowed is @count@." } ] }, "docs": "This API lists a particular number of help center users, based on the limit defined. It also helps you search for specific users." }, { "info": { "name": "Assign Labels To User", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/users/:userId/labels/assign", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API assigns the labels you specify to a particular user. " }, { "info": { "name": "Get User Groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/users/:userId/groups", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "This API lists a particular number of user groups in a help center, based on the limit defined." } ] } ], "bundled": true }