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 will have the following properties.

PropertyData TypeDescription
successbooleanWhether or not the REST API was successful.
errorErrorIf the API call was unsuccessful, this error object will contain further details.
metadataResponseMetadataDetails about the response such as the payload_name and result_set. The result_set will contain information about paged results such as count, offset, limit and a more flag.