Entities API
The Entities API provides CRUD, search, filtering, import/export, and count operations for custom and most core entity types at /api/entities/{entityName}.
Some managed core entities cannot be accessed through this generic route; they have their own dedicated APIs:
Base Endpoint
/api/entities/{entityName}Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/entities/:entityName/:entityId | Get an entity by ID |
| POST | /api/entities/:entityName | Create an entity |
| POST | /api/entities/:entityName/batch | Batch create entities |
| PUT | /api/entities/:entityName | Update an entity |
| PUT | /api/entities/:entityName/batch | Batch update entities |
| POST | /api/entities/:entityName/search | Search entities |
| GET | /api/entities/:entityName?query | Search entities by query |
| DELETE | /api/entities/:entityName/:entityId | Delete an entity |
| POST | /api/entities/:entityName/delete | Delete entities by search |
| GET | /api/entities/:entityName/count | Count entities |
| POST | /api/entities/:entityName/count | Count filtered entities |
| POST | /api/entities/:entityName/export?format={{format}}&name={{exportName}} | Export entities |
| POST | /api/entities/:entityName/import?format={{format}} | Import entities |
Security
All Entities API endpoints are secured by the authentication system. In addition, each entity operation is governed by specific entity permissions, ensuring users can only perform actions for which they have explicit authorization. Unauthorized requests will be denied accordingly.
