search-shifts-request.md

Search Shifts Request

A request for a filtered and sorted set of Shift objects.

Structure

Search Shifts Request

Fields

Name	Type	Tags	Description
query	Shift Query	Optional	The parameters of a Shift search query. Includes filter and sort options.
limit	int	Optional	number of resources in a page (200 by default). Constraints: >= 1, <= 200
cursor	string	Optional	opaque cursor for fetching the next page.

Example (as JSON)

{
  "query": {
    "filter": {
      "location_ids": [
        "location_ids4",
        "location_ids5"
      ],
      "employee_ids": [
        "employee_ids9",
        "employee_ids0"
      ],
      "status": "OPEN",
      "start": {
        "start_at": "start_at0",
        "end_at": "end_at2"
      },
      "end": {
        "start_at": "start_at4",
        "end_at": "end_at8"
      },
      "workday": {
        "date_range": {
          "start_date": "start_date6",
          "end_date": "end_date2"
        },
        "match_shifts_by": "INTERSECTION",
        "default_timezone": "default_timezone4"
      },
      "team_member_ids": [
        "team_member_ids1",
        "team_member_ids2",
        "team_member_ids3"
      ]
    },
    "sort": {
      "field": "CREATED_AT",
      "order": "DESC"
    }
  },
  "limit": 172,
  "cursor": "cursor6"
}