Skip to main content
GET
/
v4
/
user
/
me
Get current user information
curl --request GET \
  --url https://api.example.com/v4/user/me \
  --header 'x-meetergo-api-user-id: <api-key>'
{
  "id": "<string>",
  "isAdmin": true,
  "isScimDisabled": true,
  "familyName": "<string>",
  "givenName": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "title": "<string>",
  "anonymousBooking": true,
  "anonymousCalendarActivity": true,
  "slug": "<string>",
  "showGettingStartedList": true,
  "recieveEmailMarketing": true,
  "timezone": "<string>",
  "language": "en",
  "personalPage": {
    "useCustomColors": true,
    "primaryColor": "<string>",
    "secondaryColor": "<string>",
    "description": "<string>",
    "onlineProfiles": {
      "linkedIn": "<string>",
      "facebook": "<string>",
      "twitter": "<string>",
      "instagram": "<string>",
      "xing": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "customLinks": [
        {
          "name": "<string>",
          "url": "<string>",
          "icon": "<string>"
        }
      ]
    },
    "headerImage": "<string>",
    "meetingTypes": [
      {
        "meetingInfo": {
          "name": "<string>",
          "description": "<string>",
          "enableRedirect": true,
          "redirect": "<string>",
          "duration": 123,
          "channel": "local",
          "customChannelName": "<string>",
          "customChannelLink": "<string>",
          "groupBooking": true,
          "enrichInvitee": true,
          "confirmationButton": {
            "useConfirmationButton": true,
            "text": "<string>",
            "color": "<string>",
            "link": "<string>"
          },
          "bufferBefore": 123,
          "bufferAfter": 123,
          "color": {}
        },
        "spots": 123,
        "enabled": true,
        "slug": "<string>",
        "companyId": "<string>",
        "locations": [
          "<string>"
        ],
        "isGlobalQueue": true,
        "createdById": "<string>",
        "createdAt": "<string>",
        "formId": "<string>",
        "communicationSettingsId": 123,
        "availabilityId": "<string>",
        "queueId": "<string>",
        "workspaceId": "<string>",
        "userId": "<string>",
        "deletedAt": "<string>",
        "resourceChannelIds": [
          "<string>"
        ]
      }
    ]
  },
  "userType": "standard",
  "fullName": "<string>",
  "companyId": "<string>",
  "email": "<string>",
  "picture": "<string>",
  "deletedAt": "<string>",
  "referralId": "<string>",
  "calendarSyncProviders": {
    "id": "<string>",
    "type": "google"
  },
  "defaultAvailabilityId": "<string>",
  "aircallUserId": "<string>",
  "phone": "<string>",
  "wherebyApiKey": "<string>",
  "groupIds": [
    "<string>"
  ],
  "groupAdminIds": [
    "<string>"
  ],
  "meetingTypeIds": [
    "<string>"
  ],
  "meetingTypeTemplateIds": [
    "<string>"
  ],
  "appointmentIds": [
    "<string>"
  ],
  "workspaceIds": [
    "<string>"
  ],
  "reminderIds": [
    "<string>"
  ],
  "formIds": [
    "<string>"
  ],
  "dealIds": [
    "<string>"
  ],
  "queueIds": [
    "<string>"
  ],
  "queueUserGroupIds": [
    "<string>"
  ],
  "availabilityIds": [
    "<string>"
  ],
  "company": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "timezone": "<string>",
    "language": "<string>",
    "logo": "<string>",
    "description": "<string>"
  }
}

Authorizations

x-meetergo-api-user-id
string
header
required

User ID to act as when using API Key authentication (required with API Key)

Response

200 - application/json

Current user information retrieved successfully

id
string
required

User unique identifier

isAdmin
boolean
required

Whether user is a company administrator

isScimDisabled
boolean
required

Whether user is disabled via SCIM

familyName
string
required

User family name/lastname

givenName
string
required

User given name/firstname

createdAt
string
required

User creation timestamp

updatedAt
string
required

User last update timestamp

title
string
required

User job title

anonymousBooking
boolean
required

Whether user allows anonymous booking

anonymousCalendarActivity
boolean
required

Whether user allows anonymous calendar activity

slug
string
required

User unique slug for public URLs

showGettingStartedList
boolean
required

Whether to show getting started list

recieveEmailMarketing
boolean
required

Whether user receives marketing emails

timezone
string
required

User timezone

language
enum<string>
required

User preferred language

Available options:
en,
de,
fr,
es,
no,
nl,
it,
pl,
sv,
tr,
da
personalPage
object
required

User personal page configuration

userType
enum<string>
required

Type of user (standard, resource, api-platform)

Available options:
standard,
resource,
api-platform
fullName
string
required

User full name (computed)

companyId
string | null

Company ID the user belongs to

email
string

User email address

picture
string

URL to user profile picture

deletedAt
string | null

User deletion timestamp

referralId
string

Referral ID if user was referred

calendarSyncProviders
object

Calendar sync provider settings

defaultAvailabilityId
string

Default availability ID

aircallUserId
string

Aircall user ID

phone
string

User phone number

wherebyApiKey
string | null

Whereby API key

groupIds
string[]

IDs of groups the user belongs to

groupAdminIds
string[]

IDs of groups the user is admin of

meetingTypeIds
string[]

IDs of meeting types owned by the user

meetingTypeTemplateIds
string[]

IDs of meeting type templates created by the user

appointmentIds
string[]

IDs of appointments where user is a host

workspaceIds
string[]

IDs of workspaces the user belongs to

reminderIds
string[]

IDs of reminders owned by the user

formIds
string[]

IDs of forms owned by the user

dealIds
string[]

IDs of deals owned by the user

queueIds
string[]

IDs of queues the user belongs to

queueUserGroupIds
string[]

IDs of queue user groups the user belongs to

availabilityIds
string[]

IDs of availabilities owned by the user

company
object

Company basic information