Users

Gets a user by ID.

get/users/{id}

Request

  • Base URL
    https://api.reveldigital.com
  • Auth
    • OAuth 2
      Authorization codehttps://id.reveldigital.com/connect/authorize
      Token URLhttps://id.reveldigital.com/connect/token
      Scopeswebapi
    • or API key in header X-RevelDigital-ApiKey
    • or API key in query parameter api_key
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

User Id

Response

Returns the user matching the ID

idstring nullable

The user id

first_namestring nullable

The first name

last_namestring nullable

The last name

citystring nullable

The city

statestring nullable

The state

postal_codestring nullable

The postal code

countrystring nullable

The country

home_phonestring nullable

The home phone number

work_phonestring nullable

The work phone number

mobile_phonestring nullable

The mobile phone number

created_onstring date-time nullable

The date the user was created

emailstring nullable

The email address

rolestring[] nullable

The roles assigned to this user

user_namestring nullable

The username

last_activitystring date-time nullable

The date the user last logged in

email_alertsboolean nullable

Whether the user has email alerts enabled

sms_alertsboolean nullable

Whether the user has SMS alerts enabled

is_two_factorboolean nullable

Whether the user has two-factor authentication enabled

Changes

No recorded changes to this operation across all 3 revisions of this API.