Object

ResponseRoot

The JSON root object contained in every response.

Properties

data

The primary data for a request or response. If data exists, this property is an array of one or more resource objects. If no data exists, this property is an empty array or null.

errors

An array of one or more errors that occurred while executing the operation.

href
string

A link to the request that generated the response data or results; not present in a request.

Information about the request or response. The members may be any of the endpoint parameters.

next
string

A link to the next page of data or results; contains the offset query parameter that specifies the next page. See Fetch Resources by Page.

The results of the operation. If there are results, the object contains contents; otherwise, it is empty or null.

Discussion

The rules that apply to the members in this object are:

  • One of these members is required: data, results, errors, or meta.

  • Only one of these mutually exclusive members may appear: data, results, or errors.

  • These members may appear: next and href.

Topics

Related Objects

object ResponseRoot.Meta

Information about the request or response.

object ResponseRoot.Results

The results of the operation.