Skip to main content

Users

The authenticated principal behind the API key.

1 endpoint. Every request needs an Authorization: Bearer mtro_... header, and responses follow the envelope described in Errors and conventions.

GET /users/get​

Get the currently authenticated user's profile information including name, email, role, and entity.

Required scope: any valid API key for the entity.
MCP tool: whoami

Example

curl -X GET 'https://core.mtro.app/users/get' \
-H 'Authorization: Bearer mtro_your_api_key'

Response

FieldType
messagestring
errorboolean
userobject
entityobject
membershipsobject[]
activeMembershipobject
capabilitiesobject
featureAccessobject
Fields of user
FieldType
idstring
emailstring
namestring
surnamestring
emailVerifiedboolean
mobileVerifiedboolean
typestring
emailNotificationsActiveboolean
smsNotificationsActiveboolean
whatsappNotificationsActiveboolean
preferencesobject
blockchainAddressstring
profileImagestring
twoFactorobject
entityRolestring
propertyAccessstring
allowedPropertyIdsany[]
passwordChangedboolean
onboardingCompletedboolean
onboardingProgressobject