Get details of user

GET {{baseUrl}}/api/v1/users/:user_id

This API fetches the details of a particular help center user.

OAuth Scope

  • Desk.contacts.READ
  • Desk.settings.READ
  • Desk.basic.READ

Request Params

KeyDatatypeRequiredDescription
includestringAdditional information related to the user. Value allowed is contact.
helpCenterIdstringID of the help center from which the user must be fetched

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"lastAccessedTime":"2021-06-11T06:21:32.000Z","photoURL":"https://desk.zoho.com/portal/api/portalUser/17883000000094001/photo","contactId":"3313135931139","contact":{"webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38","name":"Developer","id":"3313135931139"},"name":"Developer","id":"310975130121","label":{"preferences":{"shape":"RECTANGLE","bgColor":"#39B54A","textColor":"#FFFFFF"},"name":"Lock Label","id":"24073000002823026","logoUrl":null},"type":"ENDUSER","email":[{"emailAddress":"zylcare@zylker.com","isVerified":"false","isPrimary":"true"}],"status":"ACTIVE"}