API Reference

The EntityEngine API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL

HTTP Methods

Pagination

List endpoints support pagination via query parameters:

GET /api/v1/entities?page=2&per_page=50

Paginated responses include a meta object:

{
  "success": true,
  "data": [...],
  "meta": {
    "page": 2,
    "per_page": 50,
    "total": 127,
    "total_pages": 3
  }
}

Error Codes

The API uses conventional HTTP response codes to indicate success or failure: