Skip to main content

Get User Profile API (Optional API)

MethodAPIDescription
GET/{context}/profiles?keyword={key}&docId={docId}&page_num={num}&page_limit={limit}Search for users with permissions

Function Description:
Search for users among people who have preview/edit permissions for the specified document. The search scope includes user names and emails.

Example:

GET http://172.16.52.223/v2/context/profiles?keyword=d&docId=123&page_num=1&page_limit=100

Returns:

{  
"items": [ // Required
{
"id": "300", // Required
"display_name": "Docs Test 01", // Required
"email": "docstest01@lenovo.com", // Required
"org_name": "",
"org_id": "",
"photo_url": "/testOrg/people/300.png",
"name": "docstest01",
"job_title": ""
},
{
"id": "301", // Required
"display_name": "Docs Test 02", // Required
"email": "docstest02@lenovo.com", // Required
"org_name": "",
"org_id": "",
"photo_url": "/testOrg/people/301.png",
"name": "docstest02",
"job_title": ""
}
],
"total": 2 // Required
}