Sign in
Workflows
Reference Data
v1

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. :::

get/v1/workflows/action-definitions

Query parameters

account_idstring required

The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.

Response

Success

Example response

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

Changes