Get Current User
Retrieve information about the currently authenticated user, including profile details and workspace memberships.
Your API key for authentication
Response
Unique identifier for the user
List of workspaces the user belongs to
User’s role in the workspace (e.g., “owner”, “admin”, “member”)
ISO 8601 timestamp of when the user account was created
Example Request
curl -X GET https://api.beamstudio.ai/v2/user/me \
-H "x-api-key: your-api-key"
Example Response
{
"id": "user_abc123",
"email": "user@example.com",
"name": "John Doe",
"workspaces": [
{
"id": "workspace_xyz789",
"name": "My Workspace",
"role": "owner"
},
{
"id": "workspace_def456",
"name": "Team Workspace",
"role": "admin"
}
],
"createdAt": "2024-01-15T10:30:00Z"
}
Common Use Cases
Workspace Selection
Use this endpoint to retrieve available workspaces and allow users to select which workspace to operate in.
Profile Display
Show user information in your application’s UI.
Permission Checking
Verify user roles and permissions before performing sensitive operations.
