GET /api/v1/automation-executions
Personal access token & O auth2

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[client_uuids] string

    Filter by a comma separated list of client UUIDs.

  • filter[account_uuids] string

    Filter by a comma separated list of account UUIDs.

  • include string

    Include relationships. Valid values are [account].

  • sort string

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

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string

        UUID of automation execution

      • created_at string

        Timestamp of when this execution was created

      • updated_at string

        Timestamp of when this execution was updated

      • status string

        Current status of this automation execution

      • triggered_by string

        Name of what triggered this automation execution

      • steps array[object]

        Collection of the steps in this execution

        Hide steps attributes Show steps attributes object
        • uuid string
        • created_at string
        • updated_at string
        • executed_at string
        • status string
        • info string
        • name string
      • name string

        Name of the automation blueprint

      • next_step object

        The next step set to run

        Hide next_step attributes Show next_step attributes object
        • uuid string
        • created_at string
        • updated_at string
        • executed_at string
        • status string
        • info string
        • name string
      • previous_step object

        The step that was last run

        Hide previous_step attributes Show previous_step attributes object
        • uuid string
        • created_at string
        • updated_at string
        • executed_at string
        • status string
        • info string
        • name string
      • account object

        The account this automation execution ran for (only included when requested)

        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
        • 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
GET /api/v1/automation-executions 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/automation-executions' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [
    {
      "uuid": "d1f7cf3a-f3fe-4242-b389-1fd959e6f44a",
      "created_at": "2026-05-01T16:22:07+01:00",
      "updated_at": "2026-05-01T16:22:07+01:00",
      "status": "in_progress",
      "triggered_by": "client.created",
      "steps": [
        {
          "uuid": "77076c5c-2e1f-4162-bbba-0d121ca32928",
          "created_at": "2026-05-01T16:22:07+01:00",
          "updated_at": "2026-05-01T16:22:07+01:00",
          "executed_at": "2026-05-01T16:22:07+01:00",
          "status": "completed",
          "info": "\"[{errors : \"the account_uuid field is required\" }]\"",
          "name": "Send SMS"
        }
      ],
      "name": "Send client welcome pack to newly created client",
      "next_step": {
        "uuid": "42a32225-2012-4d85-8792-3294c7d93e92",
        "created_at": "2026-05-01T16:22:07+01:00",
        "updated_at": "2026-05-01T16:22:07+01:00",
        "executed_at": "2026-05-01T16:22:07+01:00",
        "status": "completed",
        "info": "\"[{errors : \"the account_uuid field is required\" }]\"",
        "name": "Send SMS"
      },
      "previous_step": {
        "uuid": "853560ab-0a90-4e50-a23c-7fd61d68c104",
        "created_at": "2026-05-01T16:22:07+01:00",
        "updated_at": "2026-05-01T16:22:07+01:00",
        "executed_at": "2026-05-01T16:22:07+01:00",
        "status": "completed",
        "info": "\"[{errors : \"the account_uuid field is required\" }]\"",
        "name": "Send SMS"
      },
      "account": {
        "uuid": "b08d7217-e14e-44c1-85aa-aab66a6007a0",
        "created_at": "2026-05-01T16:22:07+01:00",
        "updated_at": "2026-05-01T16:22:07+01:00",
        "type": "client",
        "role": "client",
        "first_name": "Gareth",
        "last_name": "Thompson",
        "name": "Gareth Thompson",
        "email": "gareth@codepotato.co.uk",
        "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
        "firm": "App\\Http\\Resources\\FirmResource",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
        "groups": "App\\Http\\Resources\\GroupResource",
        "tags": "App\\Http\\Resources\\TagResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "first_contact_date": "2026-05-01T16:22:07+01:00",
        "next_review_date": "2026-05-01T16:22:07+01:00",
        "previous_review_date": "2026-05-01T16:22:07+01:00",
        "anniversary_review_date": "2026-05-01T16:22:07+01:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "circles": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "inactive_at": "2026-05-01",
        "last_interaction_at": "2026-05-01 16:22:07",
        "referral_code": "ABC12345",
        "permissions": {
          "firm:read": [
            "firm"
          ],
          "network:read": [
            "network:uuid"
          ]
        },
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      }
    }
  ]
}