Sorting

Order list results with sort_by; prefix a hyphen to reverse.

Add the sort_by query parameter to return list results in a defined order.

?sort_by=<attribute>

Sorting can be applied to attributes such as:

AttributeDefault orderDescription
labelAlphabeticalLabel of the entity
nameAlphabeticalName of the entity
createdAtOldest firstWhen the entity was created
lastTriggeredOldest firstWhen an event last triggered
📘

Reverse the order

Every attribute has a default order that you can invert by prefixing a hyphen — e.g. -createdAt (newest first) or -label (Z→A).

Example

List your cold-chain trackers alphabetically by label (showing only the label, via Dynamic Fields):

curl -X GET 'https://api.surfact.com/api/v2.0/devices/?sort_by=label&fields=label' \
  -H 'X-Auth-Token: your_token_here'
{
  "count": 5,
  "next": null,
  "previous": null,
  "results": [
    { "label": "pharma-fridge-a" },
    { "label": "pharma-fridge-b" },
    { "label": "reefer-trailer-01" },
    { "label": "reefer-trailer-02" },
    { "label": "vaccine-box-09" }
  ]
}

Newest devices first — useful for spotting recently provisioned trackers:

curl -X GET 'https://api.surfact.com/api/v2.0/devices/?sort_by=-createdAt' \
  -H 'X-Auth-Token: your_token_here'

Did this page help you?