This section:

• Explains what an API response is
• Explains the information that is documented in a response example
• Explains the information that is documented in a response schema

What is an API response?

An API response is generated as a reply to an API call. For successful calls the response includes information such as the data that was requested or the details of the resources that were created, edited or deleted. For unsuccessful calls the response includes an error code which outlines the reason the call failed.

The API documentation includes a response example and a response schema.

• Response Example
  The response example is a sample API response. Usually this includes a sample of the properties that are included in the response as well as the typical values that you might find associated with each property. The response example is usually not an exhaustive list of every property that can be included in a response, instead it provides a sample of the properties that can be included in a response. 
  
  Response Schema
• To see an exhaustive list of every property that can be returned, you must refer to the response schema. The response schema lists every property that can be returned and outlines information relating to the structure of the response and the data formats associated with each property.

Response example

The response example allows you to:

• See if the response contains the information you are interested in
• See the way in which the response is structured
• See how the information in the response is labelled

The following screenshot displays an example of a response example.

The response example is not always an exhaustive list of the properties that can be included in the response. To view a list of every property that can be returned by the endpoint, you must refer to the response schema.

Response schema

The response schema allows you to:

• See every property that can be returned in a response
• See a description of the data returned for each property
• See the data format for each property
• See the structure of the response

The following screenshot displays an example of a response schema.