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.
|Boolean||Defines whether the request was valid|
|Object/Array||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|
|Boolean||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.
|Number||The sum of records returned|
|Number||Total number of records to iterate through|
|Number||The current page rendered in the result set|
|Number||Total number of pages to iterate through|
Each of the sections describing API methods will assume this format and describes the body of the