v1

latestOpenAPI 3.0.02026-07-26866217.8 KB

Automation

Query upcoming 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.

get/automation/actions

Query parameters

type'message' | 'review' required

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

keywordstring

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

stay_codestring

The code of the stay.

property_idsstring

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_timestring 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_timestring date-time

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

channel_typesstring

Filter by channel types. Comma-separated channel names, e.g. airbnb,agoda.

offsetinteger

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

limitinteger

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

Response

List of upcoming automation actions and total count.

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}