Get all logs for a model

GET /api/v1/logs/{modelType}/{modelUuid}

Path parameters

  • modelType string Required

    The type of model to get logs for

  • modelUuid string Required

    UUID of the model to get logs for

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[type] string

    Filter log type.

  • filter[level] string

    Filter log level.

  • filter[modelable_type] string

    Filter logs by modelable type.

  • sort string

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

  • per_page integer

    the amount of logs per page (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
      • created_at string
      • updated_at string
      • description string
      • author object
        Hide author attributes Show author attributes object
        • uuid string
        • created_at string
        • updated_at string
        • type string
        • role string
        • first_name string
        • last_name string
        • name string
        • email 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
        • 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
        • ownership_percentage integer
        • inactive_at string
        • custom_fields string
        • external_references string
      • modelable object
        Hide modelable attributes Show modelable attributes object
        • uuid string
        • created_at string
        • updated_at string
        • type string
        • role string
        • first_name string
        • last_name string
        • name string
        • email 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
        • 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
        • ownership_percentage integer
        • inactive_at string
        • custom_fields string
        • external_references string
      • modelable_type string
      • through object
        Hide through attributes Show through attributes object
        • uuid string
        • created_at string
        • updated_at string
        • type string
        • role string
        • first_name string
        • last_name string
        • name string
        • email 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
        • 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
        • ownership_percentage integer
        • inactive_at string
        • custom_fields string
        • external_references string
      • account object
        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
        • 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
        • 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
        • ownership_percentage integer
        • inactive_at string
        • custom_fields string
        • external_references string
      • accounts array[object]
        Hide accounts attributes Show accounts attributes object
        • uuid object
          Hide uuid attributes Show uuid attributes object
          • example string
          • description string
          • collection boolean
        • created_at object
          Hide created_at attributes Show created_at attributes object
          • example string
          • description string
          • collection boolean
        • updated_at object
          Hide updated_at attributes Show updated_at attributes object
          • example string
          • description string
          • collection boolean
        • type object
          Hide type attributes Show type attributes object
          • example string
          • description string
          • collection boolean
        • role object
          Hide role attributes Show role attributes object
          • example string
          • description string
          • collection boolean
        • first_name object
          Hide first_name attributes Show first_name attributes object
          • example string
          • description string
          • collection boolean
        • last_name object
          Hide last_name attributes Show last_name attributes object
          • example string
          • description string
          • collection boolean
        • name object
          Hide name attributes Show name attributes object
          • example string
          • description string
          • collection boolean
        • email object
          Hide email attributes Show email attributes object
          • example string
          • description string
          • collection boolean
        • photo_url object
          Hide photo_url attributes Show photo_url attributes object
          • example string
          • description string
          • collection boolean
        • external_references object
          Hide external_references attributes Show external_references attributes object
          • example string
          • description string
          • collection boolean
      • type string
      • level string
      • metadata array
      • is_impersonated string
GET /api/v1/logs/{modelType}/{modelUuid}
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/logs/architecto/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "data": [
    {
      "type": "viewed",
      "uuid": "1743bf05-0a36-4c7e-8753-6a484dcf42bf",
      "level": "info",
      "author": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "ef240fcb-adf3-4c49-aaa2-d7f9c079d0ab",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-06-26T11:37:10+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-26T11:37:10+01:00",
        "with_login": true,
        "inactive_at": "2025-06-26",
        "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": "2025-06-26T11:37:10+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-06-26T11:37:10+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "previous_review_date": "2025-06-26T11:37:10+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-06-26T11:37:10+01:00"
      },
      "account": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "5a21895c-3bb0-45f1-bc12-463e3525a2ce",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-06-26T11:37:10+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-26T11:37:10+01:00",
        "with_login": true,
        "inactive_at": "2025-06-26",
        "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": "2025-06-26T11:37:10+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-06-26T11:37:10+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "previous_review_date": "2025-06-26T11:37:10+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-06-26T11:37:10+01:00"
      },
      "through": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "dc306521-813e-493e-85a7-f3fadcff6811",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-06-26T11:37:10+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-26T11:37:10+01:00",
        "with_login": true,
        "inactive_at": "2025-06-26",
        "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": "2025-06-26T11:37:10+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-06-26T11:37:10+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "previous_review_date": "2025-06-26T11:37:10+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-06-26T11:37:10+01:00"
      },
      "accounts": [
        {
          "name": {
            "example": "Gareth Thompson",
            "collection": false,
            "description": "Name"
          },
          "role": {
            "example": "client",
            "collection": false,
            "description": "Account role"
          },
          "type": {
            "example": "client",
            "collection": false,
            "description": "Account type"
          },
          "uuid": {
            "example": "8f04ee72-1282-48a3-bfd1-16bc628a2454",
            "collection": false,
            "description": "The UUID of the resource."
          },
          "email": {
            "example": "gareth@codepotato.co.uk",
            "collection": false,
            "description": "(Deprecated - Please use the primary email of the account instead). The email of the account."
          },
          "last_name": {
            "example": "Thompson",
            "collection": false,
            "description": "Last name"
          },
          "photo_url": {
            "example": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
            "collection": false,
            "description": "The photo URL of the client"
          },
          "created_at": {
            "example": "2025-06-26T11:37:10+01:00",
            "collection": false,
            "description": "The timestamp of when the resource was created."
          },
          "first_name": {
            "example": "Gareth",
            "collection": false,
            "description": "First name"
          },
          "updated_at": {
            "example": "2025-06-26T11:37:10+01:00",
            "collection": false,
            "description": "The timestamp of when the resource was updated."
          },
          "external_references": {
            "example": "App\\Http\\Resources\\ExternalReferenceResource",
            "collection": true,
            "description": "The external references that have been added to the client."
          }
        }
      ],
      "metadata": [],
      "modelable": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "308c3e45-edbb-4e4b-8d1d-951783cf7fde",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-06-26T11:37:10+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-26T11:37:10+01:00",
        "with_login": true,
        "inactive_at": "2025-06-26",
        "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": "2025-06-26T11:37:10+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-06-26T11:37:10+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "previous_review_date": "2025-06-26T11:37:10+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-06-26T11:37:10+01:00"
      },
      "created_at": "2025-06-26T11:37:10+01:00",
      "updated_at": "2025-06-26T11:37:10+01:00",
      "description": ":author :action Mantas Ruigys",
      "modelable_type": "client",
      "is_impersonated": "false"
    }
  ]
}