User API

Access and manage user profile information.

Required Role: PROFILE_FULL or FULL

Endpoints

GET/api/v1/user

Get the current user's profile information.

Example Request

curl -H "Authorization: Bearer lp_your_token" \
     https://lynxprompt.com/api/v1/user

Response

{
  "id": "bp_clw2m8k0x0001",
  "email": "[email protected]",
  "name": "John Doe",
  "image": "https://avatars.githubusercontent.com/u/12345",
  "plan": "FREE",
  "createdAt": "2024-06-15T10:30:00.000Z"
}

Response Fields

Field	Type	Description
`id`	string	Unique user identifier
`email`	string	User's email address
`name`	string \| null	User's display name
`image`	string \| null	URL to profile image
`plan`	string	Subscription tier: FREE (Users) or TEAMS
`createdAt`	string	ISO 8601 timestamp of account creation

Use Cases

•Verify your API token is working correctly
•Check your current subscription tier before making API calls
•Display user information in third-party integrations