Structure of response objects

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.

successfulBooleanDefines whether the request was valid
responseObject/ArrayThe scalar or vector serialization of records, depending on the context of the request
errorsArray of stringsList of errors encountered when processing the request
testBooleanIndicates 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.

recordsNumberThe sum of records returned
total_recordsNumberTotal number of records to iterate through
pageNumberThe current page rendered in the result set
total_pagesNumberTotal number of pages to iterate through

Each of the sections describing API methods will assume this format and describes the body of the response field.