Get all Automation Blueprints

GET /api/v1/automation-blueprints

Query parameters

include string

Comma separated list of relationships to include in the response. Valid relationships are [account,steps,webhook_targets].
filter[uuid] string

Filter by a comma separated list of UUIDs.
filter[is_active] boolean

Filter automation blueprints by which are active or not.
filter[trigger] string

Filter automation blueprints by a certain trigger type.
filter[name] string

Filter automation blueprints by a partial match to the blueprint name.
sort string

Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC. Defaults to 'name'.
per_page integer

Number of results to return with pagination (Default 15. Max 500).

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  trigger string
  
  is_active boolean
  
  account object
  
  Hide account attributes Show account attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
  
  conditions array
  
  configuration array
  
  steps array[object]
  
  Hide steps attributes Show steps attributes object
  
  uuid string
  
  created_at string
  
  updated string
  
  name string
  
  type string
  
  configuration object
  
  Hide configuration attribute Show configuration attribute object
  
  params object
  
  Hide params attribute Show params attribute object
  
  account_uuid object
  
  Hide account_uuid attributes Show account_uuid attributes object
  
  type string
  
  value string
  
  condition_state boolean
  
  parent_step_uuid string
  
  steps_count string
  
  webhook_targets array[object]
  
  Hide webhook_targets attributes Show webhook_targets attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  url string

GET /api/v1/automation-blueprints

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/automation-blueprints' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": [
    {
      "name": "Add new client on webhook",
      "uuid": "7ee45165-fec6-49e7-a19d-90f75ad45b26",
      "steps": [
        {
          "name": "create a new client",
          "type": "client.create",
          "uuid": "f031dee9-f403-47c3-8577-7467c07f3f90",
          "updated": "2025-06-25T15:10:46+01:00",
          "created_at": "2025-06-25T15:10:46+01:00",
          "configuration": {
            "params": {
              "account_uuid": {
                "type": "ref",
                "value": "trigger.account.uuid"
              }
            }
          },
          "condition_state": false,
          "parent_step_uuid": "142deba2-6297-4638-b4bb-a413d0746291"
        }
      ],
      "account": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "409f7728-0726-4b2d-b4ae-207eff1e9976",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-06-25T15:10:46+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-25T15:10:46+01:00",
        "with_login": true,
        "inactive_at": "2025-06-25",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "can_be_deleted": "false",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "next_review_date": "2025-06-25T15:10:46+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-06-25T15:10:46+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "previous_review_date": "2025-06-25T15:10:46+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-06-25T15:10:46+01:00"
      },
      "trigger": "client.create",
      "is_active": false,
      "conditions": [],
      "created_at": "2025-06-25T15:10:46+01:00",
      "updated_at": "2025-06-25T15:10:46+01:00",
      "steps_count": "1",
      "configuration": [],
      "webhook_targets": [
        {
          "url": "https://api.plannrcrm.com/api/v1/webhooks/01605357-9fba-4cab-b4f0-141476dfa4ea",
          "uuid": "0c083bcd-6a0a-4475-9065-624772c75fcc",
          "created_at": "2025-06-25T15:10:46+01:00",
          "updated_at": "2025-06-25T15:10:46+01:00"
        }
      ]
    }
  ]
}