Retrieve account details

Request

Returns details of the specified user account.

Security

SessionKey(Required scopes: customeradministrator)

Path

numberstringrequired

Alphanumeric identifier of the user account

curl -i -X GET \
  'https://docs.ticketingevents.com/_mock/openapi/accounts/{number}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Details of the specified user account were returned successfully.

Bodyapplication/json

selfstring

URI of the account resource

numberstring^[A-Z]{2}-[A-Z0-9]{8}$

Immutable identifier attached to the account

usernamestring

Unique username attached to the account

emailstring, (email)

Unique email address attached to the account

rolestring

User role assigned to the account

Enum:"customer""support""host""administrator"

verifiedboolean

True if the account email address has been verified, false otherwise

activatedboolean

True if the account is active, false if it has been deactivated

firstNamestring

The account holder's forename

lastNamestring

The account holder's surname

titlestring

The account holder's formal title

Enum:"Mr""Mrs""Ms""Mx"

dateOfBirthstring, (date)

The account holder's date of birth

phonestring, (phone)

The account holder's primary contact number

countrystring

The country associated with the account (used for regionalisation)

firstAddressLinestring

The first line of the account holder's address

secondAddressLinestring

The second line of the account holder's address

citystring

The city portion of the account holder's address

statestring

The state, parish or district portion of the account holder's address

preferencesstring

URI of the account's user preferences resource

Response

{
  "self": "/accounts/MO-6A39EE8D",
  "number": "MO-6A39EE8D",
  "username": "mothers.milk",
  "email": "marvin.milk@usmc.gov",
  "role": "customer",
  "verified": false,
  "activated": true,
  "firstName": "Marvin",
  "lastName": "Milk",
  "title": "Mr",
  "dateOfBirth": "1974-09-14",
  "phone": "+1 (268) 555 0123",
  "country": "Antigua and Barbuda",
  "firstAddressLine": "Jennings New Extension",
  "secondAddressLine": "",
  "city": "Jennings",
  "state": "Saint Mary's",
  "preferences": "/accounts/MO-6A39EE8D/preferences"
}