Retrieve Workflow Action Definitions

Retrieve every action a workflow step can run, each with what it accepts, what it produces, and the options it can be configured with.

Use this before creating or updating a workflow: an action's name is what goes into a step's action_name, and the keys of its options are what go into that step's options.

The list is the same for every account — it describes what the platform supports, not what the account has set up. Actions are added over time, so treat the list as open-ended and ignore any action you do not recognise.

Credit Note: Retrieving action definitions does not consume credits.

INFO

Requires the workflows:read OAuth2 scope.

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "data": [
        {
            "type": "workflow_action_definition",
            "id": "add_organization_to_list",
            "attributes": {
                "name": "add_organization_to_list",
                "input": {
                    "entity_type": "company",
                    "required": true,
                    "array": false,
                    "available_options": null
                },
                "output": {
                    "entity_type": "company"
                },
                "options": {
                    "list_id": {
                        "entity_type": "company_list",
                        "required": true,
                        "array": false,
                        "available_options": null
                    }
                }
            }
        },
        {
            "type": "workflow_action_definition",
            "id": "send_company_to_slack",
            "attributes": {
                "name": "send_company_to_slack",
                "input": {
                    "entity_type": "company",
                    "required": true,
                    "array": false,
                    "available_options": null
                },
                "output": {
                    "entity_type": "http_response"
                },
                "options": {
                    "channel": {
                        "entity_type": "string",
                        "required": true,
                        "array": false,
                        "available_options": null
                    }
                }
            }
        }
    ],
    "meta": {
        "num_results": 2,
        "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429

🔴500Server Error

🔴504Gateway Timeout

Retrieve Workflow Action Definitions

Request

Request Code Samples

Responses