Get user

Get user details

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Path Parameters

userId

string

required

User ID

Response

200 - application/json

User

account

string

Merchant account ID

address

object[]

User address

Show child attributes

address.address1

string

required

Primary address

address.city

string

required

Address city

address.country

string

required

Address country

address.email

string

required

Email address

address.isDefault

boolean

required

true: This is the default address<br />false: This is an additional address

address.isValidated

boolean

required

true: Address has been validated<br />false: Address has not been validated

address.state

string

required

Address state

address.zipCode

string

required

Address zip code

address.address2

string

Second address line

address.address3

string

Third address line

address.attention

string

Address recipient

address.company

string

Company name

address.kind

string

Address type

address.name

object

Show child attributes

address.name.first

string

First name on address

address.name.last

string

Last name on address

address.phone

object

Telephone number and type associated with address

Show child attributes

address.phone.kind

string

Phone type

address.phone.number

string

Telephone number

createdAt

string

Time user was created

email

string

User's email address

expiryDate

string

Time user's registration expires

extra

object

Extra user details

isActive

boolean

true: User is active<br />false: User is not active

name

object

User's full name

Show child attributes

name.first

string

User's first name

name.last

string

User's last name

name.middle

string

User's middle name

phone

object[]

User's telephone numbers and details

Show child attributes

phone.countryCode

string

Telephone country code

phone.extenstion

string

Telephone number extension

phone.kind

string

Phone type

phone.number

string

Telephone number

provider

object[]

Additional user details

Show child attributes

provider.id

string

Provider ID

provider.isActive

boolean

true: Provider is active<br />false: Provider is not active

provider.lastLoginDate

string

Most recent time user logged in

provider.name

enum<string>

Provider name

Available options:

LOCAL

provider.registrationDate

string

Date provider was registered

registrationDate

string

Time user was registered

registrationSite

string

XXX

roles

string[]

User roles

updatedAt

string

Time user was last updated

userId

string

User ID