Search Events

This endpoint serves the purpose of searching events via certain filters.

POST /events/search

Search Events

cURL

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
}
'

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

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

tags · string[]

Array of tag IDs

areas · string[]

Array of area IDs

workers · string[]

Array of worker IDs

clients · string[]

Array of client IDs

skillsets · string[]

Array of skillset IDs

unfilled · boolean · default: false

Fetched only events with unfilled shifts

unpublished_shifts · boolean · default: false

Fetched only events with unpublished shifts

pending_invites · boolean · default: false

Fetched only events with pending invites

Response

200

application/json

OK

data · Event · object[]

Show child attributes

total_count · number