API Endpoint Reference
Comprehensive reference for all available API endpoints, including request parameters, responses, and usage examples.
GET /api/v1/projects
curl -X GET https://api.example.com/v1/projects \
-H 'Authorization: Bearer YOUR_API_TOKEN'
Parameters
- page - Page number for pagination (default: 1)
- limit - Results per page (default: 20, max: 100)
- sort - Sort by field (name, created_at, updated_at)
- filter - Filter by status (active, archived, draft)
Response
{
"data": [
{
"id": "PROJ-2983",
"name": "Marketing Landing Page",
"status": "active",
"created_at": "2024-03-15T14:30:45Z"
}
],
"meta": {
"total": 145,
"page": 1,
"limit": 20
}
}
POST /api/v1/projects
curl -X POST https://api.example.com/v1/projects \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"name": "New Project",
"description": "Marketing website for Q3 2025",
"template": "landing-page"
}'
Request Body
- name (required) - Project display name
- description - Project summary text
- template - Predefined configuration (default: basic)
Response
{
"id": "PROJ-3001",
"name": "New Project",
"created_at": "2024-09-30T09:15:22Z",
"workspace_id": "WS-876543",
"status": "created"
}
Python SDK Example
from project_sdk import ProjectClient
client = ProjectClient(token="YOUR_API_TOKEN")
# List projects
projects = client.projects.list(page=2, limit=25)
print(f"Found {projects['meta']['total']} projects")
# Create project
new_project = client.projects.create(
name="E-commerce Redesign",
description="Revamp existing product platform",
template="ecommerce"
)
SDK Response
This SDK provides strongly typed responses and automatic pagination for all endpoints. The client handles authentication and request throttling automatically.
- • list() returns paginated results
- • create() returns the newly created resource
- • All responses include metadata about request limits