Search Events - Roosted HR API Documentation

POST

events

Search Events

curl --request POST \
  --url https://api.roostedhr.com/api/1_12/events/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "start_date": "2001-01-01",
  "end_date": "2001-01-01",
  "event_name": "<string>",
  "location_name": "<string>",
  "tags": [
    "<string>"
  ],
  "areas": [
    "<string>"
  ],
  "workers": [
    "<string>"
  ],
  "clients": [
    "<string>"
  ],
  "skillsets": [
    "<string>"
  ],
  "unfilled": false,
  "unpublished_shifts": false,
  "pending_invites": false
}
'

{
  "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
}

Searches events using a combination of filters. The response is paginated — use items_per_page and page query parameters.

start_date is the only required filter. All other filters are optional and combine with AND logic — only events matching every provided filter are returned.

Use the boolean filters (unfilled, unpublished_shifts, pending_invites) to surface events needing attention.

Authorizations

X-API-KEY

string

header

required

Query Parameters

items_per_page

number

Count of items per page

page

number

Page

Body

application/json

start_date

string<date>

required

Example:

"2001-01-01"

end_date

string<date>

Example:

"2001-01-01"

event_name

string

Search text for event name

location_name

string

Search text for location name of the event

Response

events

Event · object[]

Show child attributes

total_count

number

Get EventReturns details for a single event by ID.

Search Events

curl --request POST \
  --url https://api.roostedhr.com/api/1_12/events/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "start_date": "2001-01-01",
  "end_date": "2001-01-01",
  "event_name": "<string>",
  "location_name": "<string>",
  "tags": [
    "<string>"
  ],
  "areas": [
    "<string>"
  ],
  "workers": [
    "<string>"
  ],
  "clients": [
    "<string>"
  ],
  "skillsets": [
    "<string>"
  ],
  "unfilled": false,
  "unpublished_shifts": false,
  "pending_invites": false
}
'

{
  "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
}