List Events

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Minimum Plan Required: The Works

Sample Response

{
    "data": [
        {
            "id": 2369552,
            "location_ids": [
                7890
            ],
            "color": "ED6337",
            "start_date": "2022-07-07",
            "start_time": "12:00:00",
            "end_time": "12:05:00",
            "end_date": "2022-07-07",
            "title": "Take out trash",
            "description": "",
            "is_multi_day": false,
            "event_type": "general",
            "recurrence": "DTSTART:20220707T120000Z\nRRULE:FREQ=DAILY"
        }
    ]
}
Path Params
int64
required

Company ID

Query Params
int64

Location ID

date
required

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

date
required

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

int64

The limit to the response size

type
array of strings
length ≥ 1

which event types to retrieve

type
Allowed:
Headers
string
^\d{4}-\d{2}-\d{2}$

7shifts API version

uuid

Company GUID

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json