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
GET /api/v1/automation-blueprints 
curl \
 -X GET https://api.plannrcrm.com/api/v1/automation-blueprints \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "data": [
    {
      "name": "Add new client on webhook",
      "uuid": "9dfc63ba-c567-4dae-a91a-cc262ebb1981",
      "steps": [
        {
          "name": "create a new client",
          "type": "client.create",
          "uuid": "5a2b213b-6446-4a79-a8b3-b875483435d1",
          "updated": "2024-10-16T11:10:16+01:00",
          "created_at": "2024-10-16T11:10:16+01:00",
          "configuration": {
            "params": {
              "account_uuid": {
                "type": "ref",
                "value": "trigger.account.uuid"
              }
            }
          },
          "condition_state": false,
          "parent_step_uuid": "1f679388-9c76-4f03-bcf2-318d6aa995f4"
        }
      ],
      "account": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "c933819e-6ad2-464e-897b-b3bd7546dae7",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-10-16T11:10:16+01:00",
        "first_name": "Gareth",
        "updated_at": "2024-10-16T11:10:16+01: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": "2024-10-16T11:10:16+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-10-16T11:10:16+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-10-16T11:10:16+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-10-16T11:10:16+01:00"
      },
      "trigger": "client.create",
      "is_active": false,
      "conditions": [],
      "created_at": "2024-10-16T11:10:16+01:00",
      "updated_at": "2024-10-16T11:10:16+01:00",
      "steps_count": "1",
      "configuration": [],
      "webhook_targets": [
        {
          "url": "https://api.plannrcrm.com/api/v1/webhooks/01605357-9fba-4cab-b4f0-141476dfa4ea",
          "uuid": "b40dd498-feb8-43cd-ab49-0cf9d634bc2e",
          "created_at": "2024-10-16T11:10:16+01:00",
          "updated_at": "2024-10-16T11:10:16+01:00"
        }
      ]
    }
  ]
}