success flag.
Success
Error
Paginated list response
List endpoints wrap results in adata array and add a pagination object.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Standard success, error and paginated response envelopes.
success flag.
{
"success": true,
"data": {}
}
{
"success": false,
"code": "validation_error",
"message": "The request contains invalid data.",
"errors": {
"email": ["Enter a valid email address."]
}
}
| Field | Type | Description |
|---|---|---|
success | boolean | Always false on errors |
code | string | Machine-readable error code |
message | string | Human-readable description |
errors | object | Optional field-level validation errors |
data array and add a pagination object.
{
"success": true,
"data": [],
"pagination": {
"page": 1,
"limit": 50,
"total": 320,
"pages": 7
}
}
Was this page helpful?