Skip to main content
POST
/
v2
/
UserGet
Get user information
curl --request POST \
  --url http://localhost:3000/v2/UserGet \
  --header 'Content-Type: application/json' \
  --header 'X-Bunker-Token: <api-key>' \
  --data '
{
  "mode": "login",
  "identity": "<string>",
  "version": 123,
  "request_metadata": {}
}
'
{
  "status": "ok",
  "token": "<string>",
  "profile": {},
  "version": 123,
  "finaltime": 123,
  "slidingtime": 123,
  "expirationtime": 123,
  "grouproles": [
    {}
  ]
}

Authorizations

X-Bunker-Token
string
header
required

API token for authentication

Body

application/json
mode
enum<string>
required

Mode of user identification

Available options:
login,
token,
email,
phone,
custom
identity
string
required

User identifier corresponding to the mode

version
integer

Specific version of the user profile to retrieve

request_metadata
object

Additional metadata for the request

Response

200 - application/json

User information retrieved successfully

status
string
Example:

"ok"

token
string

User's unique token

profile
object

User profile information

version
integer

User record version

finaltime
integer

Final expiration time (Unix timestamp)

slidingtime
integer

Sliding expiration time (Unix timestamp)

expirationtime
integer

Calculated expiration time (Unix timestamp)

grouproles
object[]

User's group roles