Get all audits attached to a model

GET /api/v1/audits/{model}/{modelUuid}

Path parameters

  • model string Required

    the model type, valid types are ['firm','account','group','case','board_task','plan','bank_statement','bank_transaction','provider_statement','statement_transaction','expectation','statement']

  • modelUuid string Required

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • sort string

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

  • per_page integer

    the amount of audits per page (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
GET /api/v1/audits/{model}/{modelUuid} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/audits/group/modelUuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "data": [
    {
      "url": "https://plannr.co.uk",
      "type": "Sub Account",
      "uuid": "41c3b17d-ea07-4c08-b188-7ff9267a6843",
      "event": "updated",
      "account": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "393cabeb-1d20-4c83-bf39-a9cfc74f19de",
        "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"
      },
      "created_at": "2024-10-16T11:10:15+01:00",
      "ip_address": "127.0.0.1",
      "new_values": {
        "first_name": "johny"
      },
      "old_values": {
        "first_name": "john"
      },
      "user_agent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"
    }
  ]
}