Get all bulk actions on the firm

GET /api/v1/bulk-actions

Query parameters

  • filter[uuid] string

    Filter bulk actions with specific UUIDs

  • filter[name] string

    Filter bulk actions by name.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

  • sort string

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

Responses

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

      Additional properties are allowed.
GET /api/v1/bulk-actions 
curl \
 -X GET https://api.plannrcrm.com/api/v1/bulk-actions \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "logs": {
        "uuid": "2c60bad0-591a-4bfd-9bac-31a9226755fa",
        "title": "Authorization Error",
        "created_at": "2024-11-20T13:24:02+00:00",
        "updated_at": "2024-11-20T13:24:02+00:00",
        "description": "Authorization Error"
      },
      "name": "Task Bulk Action",
      "type": "api_bulk_action",
      "uuid": "8e37cf00-ed86-40d5-a141-f532a29670a2",
      "created_at": "2024-11-20T13:24:02+00:00",
      "updated_at": "2024-11-20T13:24:02+00:00",
      "executed_by": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "ddb2fb62-1319-4173-add2-e6bc568ff345",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-11-20T13:24:02+00:00",
        "first_name": "Gareth",
        "updated_at": "2024-11-20T13:24:02+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": "2024-11-20T13:24:02+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-11-20T13:24:02+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-11-20T13:24:02+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-11-20T13:24:02+00:00"
      }
    }
  ]
}