shift-query.md

Shift Query

The parameters of a Shift search query, which includes filter and sort options.

Structure

Shift Query

Fields

Name	Type	Tags	Description
filter	Shift Filter	Optional	Defines a filter used in a search for Shift records. AND logic is used by Square's servers to apply each filter property specified.
sort	Shift Sort	Optional	Sets the sort order of search results.

Example (as JSON)

{
  "filter": {
    "location_ids": [
      "location_ids4"
    ],
    "employee_ids": [
      "employee_ids9"
    ],
    "status": "OPEN",
    "start": {
      "start_at": "start_at6",
      "end_at": "end_at6"
    },
    "end": {
      "start_at": "start_at0",
      "end_at": "end_at2"
    }
  },
  "sort": {
    "field": "START_AT",
    "order": "DESC"
  }
}