2xx Response

status · enum<integer> · required

Status code of the response

Available options: 200, 201, 202

data · object any[] · required

Response data containing the requested object

message · string | null · required

Message of the response, human readable

Example:

"Resource created successfully"

env · enum<string> · required

API environment

Available options: development, production

error · string | null

Error message of the response, human readable

Example:

"Invalid email address"

log · string object

Useful informaiton, not always present, to debug the response

Example:

{ "request_id": "req_1234567890" }

validator · object

Validator response object, each key is the field name and value is the error message

Example:

{
  "email": "Invalid email address",
  "password": "Password is required"
}

support_id · string<uuid> | null

Support ID linked to the response, used to identify it when talking with our team

Example:

"support_uuidv7-something-else"