Sort By

Search endpoints accept an optional sortBy string in the request body to control result ordering.

Request shape

{
  "sortBy": "desc(createdAt)",
  "pagination": { "page": 0, "limit": 25 }
}

If sortBy is omitted, the API uses the endpoint’s default ordering.

sortBy uses the same expression parser as query, but only sorting functions are allowed.

{
  "sortBy": "asc(name)"
}

{
  "sortBy": "desc(updatedAt, 'nulls last')"
}

Function	Description
`asc(field)`	Ascending order
`desc(field)`	Descending order
`asc(field, 'nulls first' \| 'nulls last')`	Ascending with null placement
`desc(field, 'nulls first' \| 'nulls last')`	Descending with null placement

Chain sort keys with sort(...):

{
  "sortBy": "sort(desc(updatedAt), asc(name))"
}

Sort by a contact attribute using getBy:

{
  "sortBy": "asc(getBy('attributes', 'name', 'company'))"
}

Field names are case-sensitive. Each search endpoint documents its sortable fields on the sortBy property in the API reference.