Response Format

Success Response

All successful responses follow this pattern:

{
  "success": true,
  "data": {
    // Response data
  }
}

List Response

Listings include pagination metadata:

{
  "success": true,
  "data": [
    // Array of items
  ],
  "pagination": {
    "total": 100,
    "limit": 20,
    "offset": 0,
    "has_more": true
  }
}

Error Response

Errors follow a consistent pattern:

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human readable error description",
    "details": {
      // Additional information when available
    }
  }
}

HTTP Status Codes

Code	Description
`200`	Success
`201`	Created
`204`	No Content (successful deletion)
`400`	Bad Request
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found
`409`	Conflict
`429`	Rate Limit Exceeded
`500`	Internal Error

Pagination

integer

default:"20"

Maximum number of items to return (max: 100)

integer

default:"0"

Number of items to skip

Example

GET /backend/leads?limit=50&offset=100

Filters

Most list endpoints support common filters:

string

Text search in relevant fields

string

Filter by creation date (ISO 8601)

string

Filter by creation date (ISO 8601)

Example

GET /backend/leads?search=john&created_after=2024-01-01T00:00:00Z

Getting Started

Core Concepts

Best Practices

Success Response

List Response

Error Response

HTTP Status Codes

Example

Filters

Example

​Success Response

​List Response

​Error Response

​HTTP Status Codes

​Pagination

​Example

​Filters

​Example

Success Response

List Response

Error Response

HTTP Status Codes

Pagination

Example

Filters

Example