Get user details

GET 
/api/user

Returns details about the authenticated user

Request

Responses

200

Successful operation

application/json

Schema

Schema

data object

cid string

VATSIM ID

personal object

Personal details

name_first string

First name

name_last string

Last name

name_full string

Full name

email string

Email address

country object

Country of residence

id string

Country code

name string

Country name

vatsim object

rating object

Controller rating

id integer

Controller Rating ID

short string

Possible values: Value must match regular expression /[A-Z0-9]{2,4}/

Short identifier

long string

Human-readable name

pilotrating object

Pilot rating

id integer

Pilot Rating ID

short string

Possible values: Value must match regular expression /[A-Z0-9]{2,4}/

Short identifier

long string

Human-readable name

region object

Region

id string

Region ID

name string

Region name

division object

Division

id string

Division ID

name string

Division name

subdivision object

Subdivision

id string

Subdivision ID

name string

Subdivision name

oauth object

token_valid string

Possible values: [true, false]

Whether the access token is valid

Example (from schema)

{
  "data": {
    "cid": "1234567",
    "personal": {
      "name_first": "Kennedy",
      "name_last": "Steve",
      "name_full": "Kennedy Steve",
      "email": "[email protected]",
      "country": {
        "id": "US",
        "name": "United States"
      }
    },
    "vatsim": {
      "rating": {
        "id": 0,
        "short": "EXMP",
        "long": "Example Rating"
      },
      "pilotrating": {
        "id": 0,
        "short": "EXMP",
        "long": "Example Rating"
      },
      "region": {
        "id": "AMAS",
        "name": "Americas"
      },
      "division": {
        "id": "USA",
        "name": "United States"
      },
      "subdivision": {
        "id": null,
        "name": null
      }
    },
    "oauth": {
      "token_valid": "true"
    }
  }
}

500

Invalid client

application/json

Schema

Schema

error_code string

Possible values: [VSO1, VSO2, VSO3]

Error code

log_code string

Reference ID for VATSIM staff

error string

Human-readable error message

Example (from schema)

{
  "error_code": "VSO1",
  "log_code": "SSO7cQDRG",
  "error": "string"
}

Loading...