Retrieve a specific user by their ID. This endpoint returns user details including revenue information and platform data.
The unique user ID to retrieve (CUID format, e.g., clm7x1a2b000008l7h3k1b2c3)
Response Fields
Field | Type | Required | Description |
---|
id | string | Yes | Unique user identifier |
projectId | string | Yes | Project this user belongs to |
appUserId | string | No | Your app’s custom user identifier |
email | string | No | User email address |
monthlyRevenue | number | No | User’s monthly revenue/subscription amount |
country | string | No | User’s country |
userPlatform | string | No | Platform (IOS, ANDROID, WEB, OTHER) |
locale | string | No | User’s locale/language |
createdAt | string | Yes | User creation timestamp (ISO 8601) |
updatedAt | string | Yes | Last update timestamp (ISO 8601) |
Example Response
{
"id": "clm7x1a2b000008l7h3k1b2c3",
"projectId": "clm7x1a2b000008l7h3k1b2c3",
"appUserId": "my_user_456",
"email": "user@example.com",
"monthlyRevenue": 9.99,
"country": "US",
"userPlatform": "IOS",
"locale": "en_US",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z"
}
Error Responses
Status Code | Description | Example Response |
---|
404 | User not found | {"error": "User not found"} |
401 | Unauthorized - Invalid API key | {"error": "Unauthorized"} |
500 | Internal server error | {"error": "Failed to get user"} |