Demo Template
API Reference
This page demonstrates the API documentation layout. Replace this content with your own endpoints, parameters, and response examples.
Base URL
Base URL
https://api.yourproduct.com/v1
Authentication
All requests require a Bearer token in the Authorization header.
Request header
Authorization: Bearer YOUR_API_KEY
Keep your API key secure. Do not expose it in client-side code or public repositories.
Endpoints
GET/usersList all users
GET/users/{id}Get a single user
POST/usersCreate a user
DELETE/users/{id}Delete a user
Parameters — GET /users
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | optional | Results per page. Default: 20, max: 100. |
offset | integer | optional | Pagination offset. Default: 0. |
email | string | optional | Filter by email address. |
Example response
200 OK
{
"data": [
{
"id": "usr_01hx4k",
"email": "alice@example.com",
"name": "Alice Chen",
"created_at": "2026-01-15T09:30:00Z"
}
],
"meta": { "total": 84, "limit": 20, "offset": 0 }
}
Error codes
| Code | Meaning |
|---|---|
400 | Bad request — malformed parameters |
401 | Unauthorized — missing or invalid API key |
404 | Not found — resource does not exist |
429 | Rate limit exceeded — retry after the indicated delay |
500 | Server error — contact support if it persists |