Response Format

Understanding API response structure

All API responses return JSON-formatted data with a consistent structure.

Success Responses

Successful requests return the requested data with appropriate HTTP status codes:

200 OK - Request successful
201 Created - Resource successfully created
204 No Content - Request successful, no content to return

Response Structure

Single resource responses contain the object directly:

{
  "Id": 123,
  "Name": "Example",
  "Enabled": true,
  ...
}

List responses contain an array with metadata:

{
  "Items": [...],
  "TotalItemsCount": 150
}

Field Types

Dates - ISO 8601 format: 2026-07-07T00:00:00
IDs - Integers
URLs - Relative paths starting with /
Custom Properties - Nested under CustomProperties object

Code Examples

# Single Resource Response
{
  "Id": 3171,
  "Name": "Header",
  "Alias": "header",
  "Enabled": true,
  "Content": "..."
}

# List Response
{
  "Items": [
    {"Id": 1, "Name": "Item 1"},
    {"Id": 2, "Name": "Item 2"}
  ],
  "TotalItemsCount": 2
}