Core API Endpoints
GET
/api/data
Description
Retrieve paginated data records with optional filtering
Parameters
- query (string) - Filter records by keyword
- page (int) - Page number (default: 1)
Response Example
[ { "id": 1, "name": "Sample Record", "value": "ABC123" } ]
POST
/api/data
Description
Create a new data record with required fields
Request Body
{ "name": "New Item", "value": "XYZ789" }
Authentication
Bearer token in Authorization header
PUT
/api/data/{id}
Description
Modify an existing data record with specific ID
Parameters
- id (path) - Record identifier
- include_relations (bool) - Include nested relationships
Request Body
{ "name": "Updated Item", "value": "NEW123" }
Response
{ "id": 1, "name": "Updated Item", "value": "NEW123", "updated_at": "2025-03-20T14:48:00Z" }
DELETE
/api/data/{id}
Description
Delete a specific data record
Parameters
- id (path) - Target record ID
- permanent (bool) - Skip trash (default: false)
Response Status
204 No Content / 404 Not Found
Versioning
This API uses semantic versioning 1.2.3. Breaking changes will be communicated via our CHANGELOG