Query upcoming automation actions

get

https://api.hostex.io/v3/automation/actions

Returns scheduled automation actions that are waiting to run: either automated messages (type=message, same scope as the in-app “upcoming message actions” list, within the next 30 days) or automated reviews (type=review). Filters mirror the internal automation plan lists (keyword, property IDs, time range, channel types, rule event filters). Pagination uses offset and limit like other v3 list endpoints.

Query Params

type

string

enum

required

Kind of scheduled action: message for automated guest messages, review for scheduled host reviews.

Allowed:

keyword

string

Optional text matched against the plan detail payload (same as the in-app keyword filter).

stay_code

string

The code of the stay.

property_ids

string

Enter property IDs to search. Comma-separated integer IDs (e.g. 1,2,3) or a JSON array string (e.g. [1,2,3]).

start_time

date-time

Include only actions scheduled at or after this time (inclusive). ISO 8601 or Y-m-d H:i:s as accepted by date validation.

end_time

date-time

Include only actions scheduled at or before this time (inclusive).

thirdparty_types

string

Filter by internal channel type codes (thirdparty_type integers). Comma-separated or JSON array string, e.g. 0,9 or [0,9].

events

string

For type=message: JSON array string or comma-separated list of rule sub_event_type values (same as the in-app event filter). For type=review: use comment to restrict to check-in/check-out triggered rules; any other value selects guest-committed-comment rules.

offset

integer

≥ 0

Defaults to 0

Zero-based index of the first row to return. Default: 0.

limit

integer

1 to 100

Defaults to 20

Maximum number of rows to return (1–100). Default: 20.

Response

200List of upcoming automation actions and total count.