All responses from the API will adhere to a consistent format, ensuring a uniform understanding of the returned data.

Success

For a successful request, the response object includes the following fields:

data
object

Contains the main content of the response.

meta
object

Provides auxiliary information about the response.

Error

When an error occurs, the response object comprises:

error
string

A message or code that identifies the nature of the error.

meta
object

Contains additional details about the error context.