Show a bulk action.

GET /api/v1/bulk-actions/{id}

Path parameters

  • id string Required

    The ID of the bulk action.

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

      The name of the bulk action

    • type string

      The type of the bulk action

    • logs object

      Logs of the bulk action

    • executed_by object

      Account that executed bulk action
GET /api/v1/bulk-actions/{id} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/bulk-actions/id \
 -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) 
{
  "logs": {
    "uuid": "1813f2cf-5045-40c9-956b-d641e1cd7984",
    "title": "Authorization Error",
    "created_at": "2024-10-16T11:10:15+01:00",
    "updated_at": "2024-10-16T11:10:15+01:00",
    "description": "Authorization Error"
  },
  "name": "Task Bulk Action",
  "type": "api_bulk_action",
  "uuid": "92e34a46-460b-44b8-8770-83f9747547ff",
  "created_at": "2024-10-16T11:10:15+01:00",
  "updated_at": "2024-10-16T11:10:15+01:00",
  "executed_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "7bb32ade-d3e0-4799-85f2-a214ba64db57",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:15+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:15+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:15+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:15+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:15+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:15+01:00"
  }
}