All Fat Zebra API responses share the same top level syntax. This lays out the response object, whether the operation was successful or if any errors were received.
Defines whether the request was valid
The scalar or vector serialization of records, depending on the context of the request
Array of strings
List of errors encountered when processing the request
Indicates whether or not the request was made in test mode
Additionally, endpoints that list entities add the following fields to facilitate the paging of results.
The sum of records returned
Total number of records to iterate through
The current page rendered in the result set
Total number of pages to iterate through
Each of the sections describing API methods will assume this format and describes the body of the