Response Format

The response returned includes the following parts:

Property

Description

message

A string containing a brief message about the status of your request — for example “Success”.

data

An array containing the actual response elements. See Returned Data.

meta

An object containing response metadata. The meta object may include information about:

  • The page returned, and links to other pages, if a list is returned and if the resource endpoint supports pagination. See Pagination.

  • Objects referenced by internal ID in the data array (object type and internal ID). See Referenced Objects and Expansion.

errorFields

An object returned if the request fails with a HTTP status code 400, listing fields with validation errors. See Errors.

included

An array contains expanded objects referenced by internal ID in the data array, and specified in the request using the expand parameter. See Referenced Objects and Expansion.