Skip to main content
GET
/
events
Get Events
curl --request GET \
  --url https://api.roostedhr.com/api/1_12/events \
  --header 'X-API-KEY: <api-key>'
{
  "events": [
    {
      "id": 123,
      "name": "<string>",
      "date": "2023-12-25",
      "event_id": "<string>",
      "client_id": "<string>",
      "created": "2023-12-25",
      "location": {
        "id": "<string>",
        "location": "<string>",
        "addy_street_number": "<string>",
        "addy_city": "<string>",
        "addy_zip": "<string>",
        "location_comments": "<string>",
        "default": 0,
        "saved": 0,
        "color": "#DC136C",
        "timezone": {
          "id": 123,
          "name": "<string>",
          "offset": "<string>"
        },
        "companies_payroll_rulesets_id": "<string>",
        "payroll_rule_display": "<string>",
        "latitude": "<string>",
        "longitude": "<string>",
        "default_clients_id": "<string>",
        "default_areas": [
          "<string>"
        ]
      },
      "admin_origin": {
        "personnel_id": "<string>",
        "name": "<string>"
      },
      "reviewer": {
        "personnel_id": "<string>",
        "name": "<string>"
      },
      "time_tracking_manager": {
        "personnel_id": "<string>",
        "name": "<string>"
      },
      "custom_fields": [
        {
          "id": "<string>",
          "name": "<string>",
          "value": "<string>",
          "options": [
            {
              "title": "<string>",
              "value": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "total_count": 123
}
Paginated. Defaults to page 1 with 25 items per page. Use items_per_page (max 100) and page to navigate results.

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

OK

​
events
Event · object[]
​
total_count
number