GET api/users/{guid}/settings

Get an existing user's settings

Request Information

URI Parameters

NameDescriptionTypeAdditional information
guid

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Get an existing user's settings

GetUserSettingsResp
NameDescriptionTypeAdditional information
NotifySms

Whether the user should be notified by SMS

 boolean

None.
NotifyEmail

Whether the user should be notified by email

 boolean

None.
NotifyPush

Whether the user should be notified by push notification

 boolean

None.
PhoneNumber

The user's phone number

 string

None.
IsVerified

Whether the phone number is verified

 boolean

None.
SmsSent

Whether a verification SMS has been successfully sent to this user

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "notifySms": true,
  "notifyEmail": true,
  "notifyPush": true,
  "phoneNumber": "sample string 1",
  "isVerified": true,
  "smsSent": true
}

Error responses

No documented error responses