Get a Automation Blueprint

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

Headers

Authorization string
Content-Type string
Accept string

Path parameters

automationBlueprint_uuid string Required

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
  
  Additional properties are allowed.
- 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
  
  Additional properties are allowed.
- 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
  
  Additional properties are allowed.

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

curl \
 -X GET https://api.plannrcrm.com/api/v1/automation-blueprints/automationBlueprint_uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"

Response examples (200)

{
  "name": "Add new client on webhook",
  "uuid": "b1f6096d-73d0-4ff4-a896-96e935319c6a",
  "steps": [
    {
      "name": "create a new client",
      "type": "client.create",
      "uuid": "30ddc291-de86-4f90-bc13-6cd7117c3102",
      "updated": "2025-01-17T11:18:32+00:00",
      "created_at": "2025-01-17T11:18:32+00:00",
      "configuration": {
        "params": {
          "account_uuid": {
            "type": "ref",
            "value": "trigger.account.uuid"
          }
        }
      },
      "condition_state": false,
      "parent_step_uuid": "bf0498f7-4d4f-4afc-92e5-642d57d4539a"
    }
  ],
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "308dbe9d-2095-43f4-a4c6-170c61271b98",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-01-17T11:18:32+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-17T11:18:32+00:00",
    "with_login": true,
    "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-01-17T11:18:32+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-01-17T11:18:32+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-01-17T11:18:32+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-01-17T11:18:32+00:00"
  },
  "trigger": "client.create",
  "is_active": false,
  "conditions": [],
  "created_at": "2025-01-17T11:18:32+00:00",
  "updated_at": "2025-01-17T11:18:32+00:00",
  "steps_count": "1",
  "configuration": [],
  "webhook_targets": [
    {
      "url": "https://api.plannrcrm.com/api/v1/webhooks/01605357-9fba-4cab-b4f0-141476dfa4ea",
      "uuid": "1bca5351-663b-4559-b38f-9ca771a6a50a",
      "created_at": "2025-01-17T11:18:32+00:00",
      "updated_at": "2025-01-17T11:18:32+00:00"
    }
  ]
}