API v1

Errors & responses

Response envelopes, error codes, and HTTP status mapping.

Markdown version · llms.txt

Success responses

json
{
  "data": { },
  "meta": { "totalCount": 42, "limit": 50, "offset": 0 }
}

meta is optional — list endpoints include pagination; write endpoints return 201 with the created resource in data.

Error responses

json
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request body",
    "details": { }
  }
}
HTTPCodeWhen
400VALIDATION_ERRORInvalid query params or request body
401UNAUTHORIZEDMissing or invalid token
403FORBIDDENInsufficient scope (e.g. read token on write)
404NOT_FOUNDResource not in this organization
500INTERNAL_ERRORUnexpected server error
503SERVICE_UNAVAILABLEDatabase not configured