v1

latestOpenAPI 3.1.0MIT2026-07-26134154266.9 KB

Get an action

Get a single action by ID.

get/actions/{action_id}

action_idstring required

Default Response

idstring required

Unique action ID

namestring required

Action display name

descriptionstring nullable required

What this action does

api_endpointstring nullable required

The API endpoint URL this action calls

request_typestring nullable required

HTTP method (GET, POST, PUT, PATCH, DELETE)

operation_idstring nullable required

Unique operation ID used to reference this action

statusstring nullable required

Action status (e.g. "live")

pinnedboolean required

Whether this action is pinned prominently

tagsstring[] required

Tags for organizing actions

is_handoff_likeboolean required

Whether this action behaves like a handoff to a human agent

require_form_submissionboolean nullable required

Whether a form must be submitted before the action executes

restricted_to_segmentsstring[] required

Contact segment ids this action is restricted to. Empty = available to all contacts.

created_atstring date-time required

When the action was created

updated_atstring date-time required

When the action was last updated