v1

latestOpenAPI 3.0.22026-07-24154101.1 MB

Schedule Events

List Events

get/v2/company/{company_id}/events

Path parameters

company_idinteger required

Company ID

Query parameters

location_idinteger

Location ID

start_datestring date required

A date string to request only events within a range. Format YYYY-MM-DD

end_datestring date required

A date string to request only events within a range. Format YYYY-MM-DD

limitinteger

The limit to the response size

typestring[]

which event types to retrieve

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

Example response

{
  "data": [
    {
      "start_date": "2019-01-01",
      "start_time": "09:00:00",
      "end_date": "2019-01-02",
      "end_time": "17:00:00",
      "color": "5ea17c",
      "recurrence": "Daily for 10 occurrences ==> (1997 9:00 AM EDT) September 2-11 DTSTART;TZID=America/New_York:19970902T090000 RRULE:FREQ=DAILY;COUNT=10"
    }
  ]
}