Get Events

This endpoint serves the purpose of fetching events.

GET /events

Get Events

cURL

curl --request GET \
  --url https://api.roostedhr.com/api/1_12/events \
  --header 'X-API-KEY: <api-key>'

200

{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "date": "2023-12-25",
      "event_id": "<string>",
      "client_id": "<string>",
      "created": "2023-12-25",
      "location": {
        "id": 123,
        "name": "<string>",
        "address": "<string>",
        "city": "<string>",
        "zip": "<string>",
        "saved": true
      },
      "admin_origin": {
        "personnel_id": 123,
        "name": "<string>"
      },
      "reviewer": {
        "personnel_id": 123,
        "name": "<string>"
      },
      "time_tracking_manager": {
        "personnel_id": 123,
        "name": "<string>"
      },
      "custom_fields": [
        {
          "id": "<string>",
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "total_count": 123
}

Authorizations

X-API-KEY · string · header · required

Query Parameters

items_per_page · number

Count of items per page

Required range: 1 <= x <= 100

page · number

Page

Required range: x >= 1

Response

200

application/json

OK

data · Event · object[]

Show child attributes

total_count · number