A reference for common patterns in payloads and responses.
Path-Based Versioning
Header-Based Versioning
No Versioning
status
, code
, and data
fields. message
field.
items
, with a pagination
object and _links
that follow the HAL linking strategy.
GET MANY
routes support the following query parameters:
Name | Description |
---|---|
page | The page number you want to retrieve from the paginated results |
limit | The maximum number of records to return per page |
q | A search term to filter results by matching text |
sort | A comma-separated list of fields to sort the results by |
include | A urlencoded list of related objects to include with expanded data (defaults to 1 level deep) |
filters | A urlencoded list of field criteria to filter the results by |