Get User

GET 
/users/:userId

Get User

Request

Version stringrequired

API Version

Available optionsv3

userId stringrequired

User Id

application/json

Successful response

application/json

Schema

Schema

idstring

Unique identifier of the user

namestring

Full name of the user

firstNamestring

First name of the user

lastNamestring

Last name of the user

emailstring

Email address of the user

phonestring

Phone number of the user

extensionstring

Phone extension of the user

permissionsobject

User permissions controlling access to various features

scopesstring
List of OAuth scopes granted to this user
Available optionscampaigns.readonlycampaigns.writecalendars.readonlycalendars/events.writecalendars/groups.writecalendars.writecontacts.writecontacts/bulkActions.writeworkflows.readonlyworkflows.writetriggers.writefunnels.write
rolesobject

Role and access configuration for the user

lcPhoneobject

LC Phone Inbound Phone Numbers

platformLanguagestring
Platform language preference for the user
Available optionsen_USesfr_CAfr_FRnldept_PTpt_BRitsvdafi

Example (auto)

{
  "id": "0IHuJvc2ofPAAA8GzTRi",
  "name": "John Deo",
  "firstName": "John",
  "lastName": "Deo",
  "email": "[email protected]",
  "phone": "+1 808-868-8888",
  "extension": "",
  "permissions": {
    "campaignsEnabled": true,
    "campaignsReadOnly": false,
    "contactsEnabled": true,
    "workflowsEnabled": true
  },
  "scopes": [
    "contacts.write",
    "campaigns.readonly"
  ],
  "roles": {
    "type": "account",
    "role": "admin",
    "locationIds": [
      "ve9EPM428h8vShlRW1KT"
    ]
  },
  "lcPhone": {
    "locationId": "+1234556677"
  },
  "platformLanguage": "en_US"
}