Standard Responses

We strive for all our responses to have a standard response envelope. This guarantees that the interaction style for all REST APIs will feel similar. The standard response object has the following properties.

Property	Data Type	Description
success	boolean	Whether or not the REST API call was successful.
error	Error	If the API call was unsuccessful, this error object contains further details. See Errors.
metadata	ResponseMetadata	Details about the response, such as the payload_name and result_set. The result_set contains information about paged results such as count, offset, limit, and a more flag. See Pagination.