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

      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
      • business_unit string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • terms_of_business_at string
      • client_agreement_at string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object

        • firm:read array[string]
        • network:read array[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