Skip to main content
Note: Users who have not activated their account will have a pending status. These users’ created_at timestamp will also display the time at which the API call was made, not the account’s creation date. Scopes: user:read:admin, user:read, user_info:read
  • Note: The user_info:read scope is only available when you pass the me value for the $userId value. Rate Limit Label: Light.

​
Parameters​

ParameterDescription
Encrypted EmailWhether the email address passed for the userId value is an encrypted email address:- true — The email address is encrypted.
  • false — The email address is not encrypted.If you do not query this parameter, this value defaults to null (false). | | Login Type | The user’s login method:- 0 — Facebook OAuth
  • 1 — Google OAuth
  • 24 — Apple OAuth
  • 27 — Microsoft OAuth
  • 97 — Mobile device
  • 98 — RingCentral OAuth
  • 99 — API user
  • 100 — Zoom Work email
  • 101 — Single Sign-On (SSO)The following login methods are only available in China:- 11 — Phone number
  • 21 — WeChat
  • 23 — Alipay. | | Search By Unique ID | Whether the queried userId value is an employee unique ID:- true — The queried ID is an employee’s unique ID.
  • false — The queried ID is not an employee’s unique ID.This value defaults to false (null). | | User ID | The user ID or email address of the user. For user-level apps, pass the me value. |

​
Example Output​

{    "account_id": "q6gBJVO5TzexKYTb_I2rpg",    "account_number": 10009239,    "cms_user_id": "KDcuGIm1QgePTO8WbOqwIQ",    "company": "Jill",    "created_at": "2018-10-31T04:32:37Z",    "custom_attributes": {        "key": "cbf_cywdkexrtqc73f97gd4w6g",        "name": "A1",        "value": "1"    },    "dept": "Developers",    "email": "jchill@example.com",    "employee_unique_id": "HqDyI037Qjili1kNsSIrIg",    "first_name": "Jill",    "group_ids": [        "RSMaSp8sTEGK0_oamiA2_w"    ],    "host_key": "299492849",    "id": "zJKyaiAyTNC-MWjiWC18KQ",    "im_group_ids": [        "t-_-d56CSWG-7BF15LLrOw"    ],    "jid": "jchill@example.com",    "job_title": "API Developer",    "language": "en-US",    "last_client_version": "5.9.6.4993(mac)",    "last_login_time": "2021-05-05T20:40:30Z",    "last_name": "Chill",    "location": "Paris",    "login_type": 101,    "manager": "thill@example.com",    "personal_meeting_url": "example.com",    "phone_country": "US",    "phone_number": "+1 800000000",    "phone_numbers": [        {            "code": "+1",            "country": "US",            "label": "Mobile",            "number": "800000000",            "verified": true        }    ],    "pic_url": "example.com",    "plan_united_type": "16",    "pmi": 3542471135,    "pronouns": "3123",    "pronouns_option": 1,    "role_id": "0",    "role_name": "Admin",    "status": "pending",    "timezone": "Asia/Shanghai",    "type": 1,    "use_pmi": false,    "vanity_url": "example.com",    "verified": 1}

​
Workflow Library Example​

Setting Up an Incident Process
Workflow LibraryPreview this Workflow on desktop