REST API Structure

Synaplan has migrated from an action-based API to a modern, RESTful architecture built on Symfony. All new endpoints follow standard HTTP methods and resource-based paths.

URL Structure

All API routes are prefixed with /api/v1/.

Method	Path	Action
`GET`	`/api/v1/widgets`	List all widgets
`POST`	`/api/v1/widgets`	Create a new widget
`GET`	`/api/v1/widgets/{id}`	Get widget details
`PATCH`	`/api/v1/widgets/{id}`	Update a widget
`DELETE`	`/api/v1/widgets/{id}`	Delete a widget

Data Formats

Request Body: JSON (Content-Type: application/json) is preferred for most POST/PATCH requests. For file uploads, use multipart/form-data.
Response Body: Always returns JSON.
Errors: Standard HTTP status codes (400, 401, 403, 404, 500) with a JSON error object:
```
{
  "error": "Error message description"
}
```

Request Example (JSON)

Updating a widget configuration:

curl -X PATCH "https://web.synaplan.com/api/v1/widgets/wgt_abc123" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "New Support Chat Name",
       "isActive": true
     }'

Detailed Endpoint List

For a complete list of all RESTful resources and their parameters, please refer to the Swagger documentation:

👉 Interactive API Reference