List events

Get organized event IDs for a specific date or a date range

Path Parameters

companyID companyID required

The id of the company

Query Parameters

date date

A single date to get events for (YYYY-MM-DD)

startDate date

The start date to get events for (YYYY-MM-DD)

endDate date

The end date to get events for (YYYY-MM-DD)

Responses

• 200
• 400
• 403

---

A list of event IDs

application/json

Schema

Example (from schema)

---

Schema

items object[]
List of event IDs
Array [
id string
Unique ID of the event
]

{
  "items": [
    {
      "id": "2020-01-01:2e8f9915-fda0-450c-95a3-d61f93c66fa9"
    }
  ]
}

An error when a parameter is missing

application/json

Schema

Example (from schema)

---

Schema

message string

Error message

{
  "message": "User not found"
}

An error when this date is not allowed

application/json

Schema

Example (from schema)

---

Schema

message string

Error message

{
  "message": "User not found"
}

Loading...