User

Get Yourself πŸ“‡

Changed on

Retrieve details about the currently authenticated user. Perfect for a quick self-check!

get/api/v1/user/me

Request

Response

User details

idstring uuid required
firstNamestring nullable required
lastNamestring nullable required
emailstring email nullable required
biostring nullable
role'SUPERUSER' | 'USER' | 'MEDIA_BUYER' | 'AFFILIATE' required
emailIsVerifiedboolean nullable required
telegramIsVerifiedboolean nullable required
createdAtunknown required
updatedAtunknown required
profileUrlstring nullable
usernamestring nullable
contactViberstring nullable
contactEmailstring nullable
contactTelegramNicknamestring nullable
contactTelegramPhonestring nullable
contactWhatsappstring nullable
contactFacebookstring nullable
contactDiscordstring nullable
companyNamestring nullable
companyLogostring nullable
companyRolestring nullable
companyIdstring uuid nullable
companyUserIdstring uuid nullable
teamIdstring uuid nullable
extendyEnabledboolean

Example response

{
  "accessList": {
    "app_events_delete": false,
    "app_events_read": true,
    "app_events_write": false,
    "balances_delete": false,
    "balances_read": true,
    "balances_write": false,
    "landings_delete": false,
    "landings_read": true,
    "landings_show_own_only": false,
    "landings_write": false,
    "members_delete": false,
    "members_read": true,
    "members_write": false,
    "offers_delete": false,
    "offers_read": true,
    "offers_show_own_only": false,
    "offers_write": false,
    "pixels_delete": false,
    "pixels_read": true,
    "pixels_show_own_only": false,
    "pixels_write": false,
    "push_delete": true,
    "push_read": false,
    "push_show_own_only": false,
    "push_write": true,
    "pwa_delete": false,
    "pwa_read": true,
    "pwa_show_own_only": false,
    "pwa_write": false,
    "teams_delete": false,
    "teams_read": true,
    "teams_write": false,
    "trackers_delete": false,
    "trackers_read": true,
    "trackers_show_own_only": false,
    "trackers_write": false
  },
  "bio": "I am a software engineer",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "companyLogo": "https://example.com/api/v1/photo/company_logo.jpg",
  "companyName": "Example Company",
  "companyRole": "Software Engineer",
  "companyUserId": "123e4567-e89b-12d3-a456-426614174001",
  "contactDiscord": "<EMAIL>",
  "contactEmail": "<EMAIL>",
  "contactFacebook": "<EMAIL>",
  "contactTelegramNickname": "<EMAIL>",
  "contactTelegramPhone": "<EMAIL>",
  "contactViber": "<EMAIL>",
  "contactWhatsapp": "<EMAIL>",
  "createdAt": "2021-01-01T00:00:00",
  "email": "oleg_vinnyk@gmail.com",
  "emailIsVerified": true,
  "firstName": "Oleg",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastName": "Vinnyk",
  "profileUrl": "https://example.com/api/v1/photo/user_profile.jpg",
  "roles": "USER",
  "telegramIsVerified": false,
  "updatedAt": "2021-01-01T00:00:00",
  "username": "olegVinnyk"
}

Changes