Get a Automation Blueprint | PlannrCRM API documentation

Get a Automation Blueprint Run in API Explorer

GET /api/v1/automation-blueprints/{automationBlueprint_uuid}

Path parameters

automationBlueprint_uuid string Required

The UUID of the automation

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- name string
  
  Name of the Automation Blueprint
- trigger string
  
  What type of event will trigger this AutomationBlueprint
- is_active boolean
  
  Is the automation currently active? If false will not create new execution instances
- account object
  
  Account that made this automation blueprints
  
  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
  
  photo_url 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
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
- conditions array
  
  Conditions for the automation blueprint
- configuration array
  
  Extra configuration options for the trigger of this blueprint
- steps array[object]
  
  All blueprint steps attached to this blueprint
  
  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
  
  Amount of blueprints steps on this automation blueprint
- webhook_targets array[object]
  
  List of webhook target endpoints that can be used to trigger this automation
  
  Hide webhook_targets attributes Show webhook_targets attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  url string

GET /api/v1/automation-blueprints/{automationBlueprint_uuid}

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/automation-blueprints/dcf0-484e-a0c5-08590fe89a84-f6aa1670' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "name": "Add new client on webhook",
  "uuid": "03b7fbd4-3761-4c5e-9d46-ae8e38134287",
  "steps": [
    {
      "name": "create a new client",
      "type": "client.create",
      "uuid": "bcd60e7f-84e6-4ad8-af0b-938a4e10a184",
      "updated": "2025-11-17T21:14:40+00:00",
      "created_at": "2025-11-17T21:14:40+00:00",
      "configuration": {
        "params": {
          "account_uuid": {
            "type": "ref",
            "value": "trigger.account.uuid"
          }
        }
      },
      "condition_state": false,
      "parent_step_uuid": "70eec92f-1320-451d-9308-276cf2e67ae3"
    }
  ],
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "53913569-130d-47f0-91af-3d1d21fad0ce",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2025-11-17T21:14:40+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-11-17T21:14:40+00:00",
    "with_login": true,
    "inactive_at": "2025-11-17",
    "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-11-17T21:14:40+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-11-17T21:14:40+00: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-11-17T21:14:40+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-11-17T21:14:40+00:00"
  },
  "trigger": "client.create",
  "is_active": false,
  "conditions": [],
  "created_at": "2025-11-17T21:14:40+00:00",
  "updated_at": "2025-11-17T21:14:40+00:00",
  "steps_count": "1",
  "configuration": [],
  "webhook_targets": [
    {
      "url": "https://api.plannrcrm.com/api/v1/webhooks/01605357-9fba-4cab-b4f0-141476dfa4ea",
      "uuid": "baccb3f5-e9af-424e-b38f-4b5c4902c610",
      "created_at": "2025-11-17T21:14:40+00:00",
      "updated_at": "2025-11-17T21:14:40+00:00"
    }
  ]
}