07 Collections

If a response contains more than one result it is served as a collection of resources. Theses collections always contain only one type of resources.

Partitions

Collections are served in partitions limited to a maximum of 50 items.

When requesting a collection it is possible to pass two parameters: offset and limit. Offset defaults to 0 and limit defaults to 50, if a larger value for limit is passed it is set to 50. If you receive fewer items than you asked for you are at the end of the collection.

Retrieving the whole collection can be done by repeatedly requesting the collection, starting with an offset value of 0, and then increasing the offset for each request until the response contains fewer elements than requested or if it is empty.