# Sorting
For endpoints with List requests, the API supports sorting the response based on predefined system fields
Sorting is added as a parameter sort=field_name in the request
The default sorting when using sortable field is from smaller to larger or older to newer. Sorting can be reversed by putting a minus - sign before sortable field like sort = -field_name
Examples
- if you sorted by
sort = created_at, API will return oldest created to newest created. - if you sorted by
sort = -created_at, API will return newest created to oldest created.
List of sortables for each API endpoint is available in the endpoint details
Samples
- Request without sorting
GET URL/api/customers
API Response
{
"data": [
{
"id": "8d831d65",
"name": "Hasan Ali",
"dial_code": 966,
"phone": "542325489",
"created_at": "2019-04-24 08:12:26",
},
{
"id": "8d831e26",
"name": "Ali Hamad",
"dial_code": 966,
"phone": "542125489",
"created_at": "2019-10-12 11:15:35",
},
{
"id": "8d831e26",
"name": "Jhon Raid",
"dial_code": 966,
"phone": "542136985",
"created_at": "2019-06-05 15:36:15",
}
]
}
- Request sorted with
created_at
GET URL/api/customers?sort=created_at
API Response
{
"data": [
{
"id": "8d831d65",
"name": "Hasan Ali",
"dial_code": 966,
"phone": "542325489",
"created_at": "2019-04-24 08:12:26",
},
{
"id": "8d831e26",
"name": "Jhon Raid",
"dial_code": 966,
"phone": "542136985",
"created_at": "2019-06-05 15:36:15",
},
{
"id": "8d831e26",
"name": "Ali Hamad",
"dial_code": 966,
"phone": "542125489",
"created_at": "2019-10-12 11:15:35",
}
]
}
- Request sorted with
-created_at
GET URL/api/customers?sort=-created_at
API Response
{
"data": [
{
"id": "8d831e26",
"name": "Ali Hamad",
"dial_code": 966,
"phone": "542125489",
"created_at": "2019-10-12 11:15:35",
},
{
"id": "8d831e26",
"name": "Jhon Raid",
"dial_code": 966,
"phone": "542136985",
"created_at": "2019-06-05 15:36:15",
}
{
"id": "8d831d65",
"name": "Hasan Ali",
"dial_code": 966,
"phone": "542325489",
"created_at": "2019-04-24 08:12:26",
}
]
}