Optional filter query parameters

Parameter

Type

Description

date

String

Allowing querying all events by a specific date: YYYY-MM-DD.

date[gte]

String

Grab events where date is greater than equal to a date: YYYY-MM-DD.

date[lte]

String

Grab events where date is less than equal to a date: YYYY-MM-DD.

limit

Integer

The limit of results that will be returned.

offset

Integer

Return results starting from an offset.

order_field

String

The field you would like the results to be ordered by. Format is {lowercased-singular-method}.{field}. Example: /events/?order_field=event.modified

order_dir

String

The direction you want the results ordered by. Accepted values are "asc" or "desc". Example: /events/?order_dir=desc

Example request

https://api.7shifts.com/v1/events?date[gte]=2021-08-05&date[lte]=2021-08-15

Example response

{
  "status": "success",
  "data": [
    {
      "event": {
        "id": 123,
        "start": "18:00:00",
        "description": "Test description",
        "modified": "2020-05-15 20:42:09",
        "end_date": "2022-05-11",
        "color": "4896ec",
        "all_day": false,
        "title": "Band playing!",
        "date": "2022-05-11",
        "is_multi_day": false,
        "created": "2020-05-15 20:42:09",
        "end": "19:00:00"
      },
      "location": [
        {
          "created": "2012-02-21 20:57:33",
          "mon_hours_close": "22:00:00",
          "wed_hours_close": "00:00:00",
          "modified": "2021-08-09 17:09:50",
          "wed_hours_open": "07:15:00",
          "country": "US",
          "thu_hours_close": "01:00:00",
          "fri_hours_close": "23:00:00",
          "sun_hours_open": "12:00:00",
          "city": "",
          "sat_hours_close": "00:00:00",
          "tue_hours_open": "07:45:00",
          "events_group": {
            "id": 0,
            "event_id": 123,
            "group_id": 1234
          },
          "department_based_budget": false,
          "state": "FL",
          "id": 1234,
          "shift_feedback": false,
          "mon_hours_open": "07:00:00",
          "timezone": "America/Regina",
          "thu_hours_open": "12:15:00",
          "message": "",
          "hash": "123a93bb4b728af1a7b1f7da5cfce896",
          "tue_hours_close": "23:00:00",
          "domain_id": 334,
          "sun_hours_close": "01:00:00",
          "sat_hours_open": "07:00:00",
          "address": "Burnaby - Dining (DAY)",
          "fri_hours_open": "07:00:00"
        }
      ]
    },
    {
      "event": {
        "id": 1234,
        "start": "18:00:00",
        "description": "",
        "modified": "2021-04-20 15:53:58",
        "end_date": "2021-05-18",
        "color": "4896ec",
        "all_day": false,
        "title": "Happy Hour",
        "date": "2021-05-18",
        "is_multi_day": false,
        "created": "2021-04-19 17:17:58",
        "end": "19:00:00"
      },
      "location": [
        {
          "created": "2012-02-21 20:57:33",
          "mon_hours_close": "22:00:00",
          "wed_hours_close": "00:00:00",
          "modified": "2021-08-09 17:09:50",
          "wed_hours_open": "07:15:00",
          "country": "US",
          "thu_hours_close": "01:00:00",
          "fri_hours_close": "23:00:00",
          "sun_hours_open": "12:00:00",
          "city": "",
          "sat_hours_close": "00:00:00",
          "tue_hours_open": "07:45:00",
          "events_group": {
            "id": 0,
            "event_id": 1234,
            "group_id": 445
          },
          "department_based_budget": false,
          "state": "FL",
          "id": 445,
          "shift_feedback": false,
          "mon_hours_open": "07:00:00",
          "timezone": "America/Regina",
          "thu_hours_open": "12:15:00",
          "message": "dhd ",
          "hash": "123a93bb4b728af1a7b1f7da5cfce896",
          "tue_hours_close": "23:00:00",
          "domain_id": 334,
          "sun_hours_close": "01:00:00",
          "sat_hours_open": "07:00:00",
          "address": "Burnaby - Dining (DAY)",
          "fri_hours_open": "07:00:00"
        }
      ]
    }
  ],
  "offset": 0,
  "total": 2,
  "limit": 300
}
Language
Authentication
Basic
base64
:
Response
Click Try It! to start a request and see the response here!