Order By
order_by query parameter allows clients to customize the sorting of resources in the API response. By specifying fields and sort directions, you can control the order in which results are returned. This feature is especially useful for creating ordered views or paginated responses.Usage
order_by parameter supports two formats:1.
?order_by=field:asc,another_field:desc2.
?order_by[]=field:asc&order_by[]=another_field:descSort Direction
asc for ascending order (default)desc for descending orderDefault Order
order_by is omitted entirely, resources are sorted by id:asc (oldest first). A small number of resources define their own default order instead (for example, fields are sorted by type, then required, then name) — for those, omitting order_by uses that default rather than id:asc.Sorting Behavior
Examples
Single Field Sorting
GET /api/resource?order_by=name:asc[
{ "id": 1, "name": "Alice" },
{ "id": 2, "name": "Bob" }
]Multiple Fields Sorting
GET /api/resource?order_by=name:asc,description:descname in ascending order.name, they are further sorted by description in descending order.[
{ "id": 1, "name": "Alice", "description": "Zebra" },
{ "id": 2, "name": "Alice", "description": "Apple" },
{ "id": 3, "name": "Bob", "description": "Monkey" }
]Array-style Query
GET /api/resource?order_by[]=name:asc&order_by[]=description:descError Handling
asc or desc), the API returns a 422 Unprocessable Entity response with an error message naming the offending column.Summary
order_by to control the sorting of API responses.order_by sorts by id:asc, unless the resource defines its own default order.order_by parameter, you can efficiently organize API responses to suit your application needs.Modified at 2026-08-03 22:05:31