Sorting

As a means to order a collection of resources, sort parameters can be set. Sorting is not universally supported throughout the whole API, but most collection endpoints support some form of sorting.

Query Parameters

Name Type Description
sort[ path ] string Direction: asc for ascending or desc for descending

Property path

property path = [ resource ] [ { ".", ? resource name ? } ] ".", ? property name ? ;
resource      = "self" | ? resource name ? ;

Examples

?sort[fullName]=asc

?sort[messages.comments.created]=desc