API Reference Page from TypeScript
api-reference-page-from-typescript.txt
mdx
---
title: 'Get User'
description: 'Retrieve a user by their unique identifier'
api: 'GET /api/users/{userId}'
---
# Get User
Retrieves a user by their unique identifier.
## Path Parameters
<ParamField path="userId" type="string" required>
The user's unique identifier
</ParamField>
## Response
<ResponseField name="id" type="string" required>
Unique user identifier
</ResponseField>
<ResponseField name="email" type="string" required>
User's email address
</ResponseField>
<ResponseField name="name" type="string" required>
Display name
</ResponseField>
<ResponseField name="role" type="'admin' | 'user' | 'guest'" required>
User role determining access permissions
</ResponseField>
## Code Examples
<CodeGroup>
```typescript TypeScript SDK
import { getUser } from '@yourapp/sdk';
const user = await getUser('user_123');
console.log(user.name);
```
```javascript JavaScript
const response = await fetch('/api/users/user_123');
const user = await response.json();
```
```python Python
import requests
response = requests.get('https://api.yourapp.com/users/user_123')
user = response.json()
```
```bash cURL
curl https://api.yourapp.com/users/user_123 \\
-H "Authorization: Bearer YOUR_TOKEN"
```
</CodeGroup>
## Response Example
<ResponseExample>
```json 200 Success
{
"id": "user_123",
"email": "user@example.com",
"name": "John Doe",
"role": "user",
"createdAt": "2025-10-16T12:00:00Z"
}
```
```json 404 Not Found
{
"error": "User not found",
"code": "USER_NOT_FOUND"
}
```
</ResponseExample>
## Error Codes
<ResponseField name="404" type="NotFoundError">
User with the specified ID doesn't exist
</ResponseField>
<ResponseField name="403" type="AuthorizationError">
Caller lacks permission to access this user
</ResponseField>