Skip to main content
GET
/
v2
/
user
/
me
Get Current User
curl --request GET \
  --url https://api.beamstudio.ai/v2/user/me \
  --header 'x-api-key: <api-key>'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "featureFlags": [
    {
      "name": "beta_ai_features",
      "isGlobal": false,
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "avatarSrc": "https://cdn.example.com/avatars/user123.jpg",
  "workspaces": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "name": "My Company Workspace",
      "iconSrc": "https://cdn.example.com/icons/workspace123.png",
      "domain": "mycompany.beam.ai",
      "creatorId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Response

200 - application/json

User profile retrieved successfully

​
id
string
required

The unique identifier of the user

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string
required

The full name of the user

Example:

"John Doe"

​
email
string
required

The email address associated with the user account

Example:

"john.doe@example.com"

​
featureFlags
object[]
required

Feature flags enabled for this user, controlling access to beta or experimental features

​
avatarSrc
string

URL to the user's profile picture or avatar image

Example:

"https://cdn.example.com/avatars/user123.jpg"

​
workspaces
object[]

List of workspaces the user has access to