Retrieves a user
GET {{baseUrl}}/settings/v3/users/:userId?idProperty=<string>
Retrieves a user identified by userId
. userId
refers to the user's ID by default, or optionally email as specified by the IdProperty
query param.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
idProperty | string | The name of a property with unique user values. Valid values are USER_ID (default) or EMAIL |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"email":"\u003cstring\u003e","id":"\u003cstring\u003e","primaryTeamId":"\u003cstring\u003e","roleIds":["\u003cstring\u003e","\u003cstring\u003e"],"sendWelcomeEmail":"\u003cboolean\u003e","roleId":"\u003cstring\u003e","secondaryTeamIds":["\u003cstring\u003e","\u003cstring\u003e"],"superAdmin":"\u003cboolean\u003e"}