Request structure

Example request:

{
  "page": { ... },
  "meta": { ... }
}

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

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

Some endpoints may support an optional meta property for non-standard data or metadata. This will be outlined in the endpoint documentation if applicable.

Feedback

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