Response structure

Example response:

{
  "deal": { ... },
  "errors": [],
  "included": { ... },
  "meta": { ... }
}

Each response has a root property for the main data, which is the camel-cased entity type; deal in the example above. The entity type will be in its singular form when using a single entity endpoint but plural when dealing with a list endpoint (e.g. deals).

The value of the deal property would be a deal model, i.e. a resource object / entity model.

The errors property is an array of errors. See the Errors section for more.

The included property will be returned if you are including related entities.

The meta property contains pagination information as well as any non-standard data or metadata the given endpoint may return.

Feedback

If you have any feedback or suggestions, feel free to contact us at api@teamwork.com.