[METHOD] /api/v1/[endpoint]
Description
Brief explanation of what this endpoint does.
Authentication
Required authentication method (e.g., Bearer token).
Parameters
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | Resource ID |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (default: 1) |
| limit | integer | No | Items per page (default: 20) |
Request Body
{
"field": "value"
}
Responses
200 OK
{
"success": true,
"data": {
"id": "123",
"name": "Example"
}
}
400 Bad Request
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid input"
}
}
404 Not Found
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
}
}
Examples
cURL
curl -X GET "https://api.example.com/api/v1/endpoint" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"
JavaScript
const response = await fetch('/api/v1/endpoint', {
headers: {
'Authorization': 'Bearer token',
'Content-Type': 'application/json'
}
});
const data = await response.json();
Python
import requests
response = requests.get(
'https://api.example.com/api/v1/endpoint',
headers={'Authorization': 'Bearer token'}
)
data = response.json()
Rate Limits
- 1000 requests per hour for authenticated users
- 100 requests per hour for public endpoints