Skip to main content
GET
Get Token Information

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Response

200 - application/json;charset=UTF-8

Token information retrieved successfully.

Comprehensive information associated with an authenticated token, including customer details, user information, hierarchy, and localization settings

customerId
string

Unique identifier of the customer

emailAddress
string

Email address of the user

userName
string

Username of the user

customerName
string

Name of the customer organization

locale
object

Locale preference of the user

currency
string

Currency code used by the user

personId
string

Unique identifier of the person

groupId
string

Unique identifier of the primary group

groupName
string

Name of the primary group

groupPath
object[]

Path of groups in the hierarchy

enabledFeatures
string[]

List of enabled feature keys

Features enabled for this token

fullName
string

Full name of the person

customerIds
string[]

Set of customer IDs

Identifiers of all customers accessible by the user

metadata
object

Feature-specific metadata

timezone
string

The timezone

dateFormat
string

Date format pattern

unitSettings
object

Unit settings

region
string

Geographical region of the customer

driver
boolean

Indicates whether the user is a driver

webUser
boolean

Indicates whether the user is a web user

tempAdminUser
boolean