GET /api/v1/logs/{modelType}/{modelUuid}
Personal access token & O auth2

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
        • 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
        • terms_of_business_at string
        • client_agreement_at 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
      • 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
        • 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
        • terms_of_business_at string
        • client_agreement_at 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
      • modelable_type string
      • modelable_name 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
        • 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
        • terms_of_business_at string
        • client_agreement_at 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
      • 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
        • 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
        • terms_of_business_at string
        • client_agreement_at 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
      • 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": [
    [
      {
        "uuid": "9c41ea02-e9b9-4b9e-8872-46f4d33ee4a7",
        "created_at": "2026-05-19T18:31:18+01:00",
        "updated_at": "2026-05-19T18:31:18+01:00",
        "description": ":author :action Mantas Ruigys",
        "author": {
          "uuid": "b8888b76-6f5b-48e6-8327-ae54e2722dd8",
          "created_at": "2026-05-19T18:31:18+01:00",
          "updated_at": "2026-05-19T18:31:18+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-19T18:31:18+01:00",
          "next_review_date": "2026-05-19T18:31:18+01:00",
          "previous_review_date": "2026-05-19T18:31:18+01:00",
          "anniversary_review_date": "2026-05-19T18:31:18+01:00",
          "terms_of_business_at": "2026-05-19T18:31:18+01:00",
          "client_agreement_at": "2026-05-19T18:31:18+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-19",
          "last_interaction_at": "2026-05-19 18:31:18",
          "referral_code": "ABC12345",
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
          "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
        },
        "modelable": {
          "uuid": "4b2fb22f-678a-427b-81ba-977f6587b7a0",
          "created_at": "2026-05-19T18:31:18+01:00",
          "updated_at": "2026-05-19T18:31:18+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-19T18:31:18+01:00",
          "next_review_date": "2026-05-19T18:31:18+01:00",
          "previous_review_date": "2026-05-19T18:31:18+01:00",
          "anniversary_review_date": "2026-05-19T18:31:18+01:00",
          "terms_of_business_at": "2026-05-19T18:31:18+01:00",
          "client_agreement_at": "2026-05-19T18:31:18+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-19",
          "last_interaction_at": "2026-05-19 18:31:18",
          "referral_code": "ABC12345",
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
          "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
        },
        "modelable_type": "client",
        "modelable_name": "Mantas Ruigys",
        "through": {
          "uuid": "39ef59b8-d69a-4004-a5d8-fc73a0d1a1fb",
          "created_at": "2026-05-19T18:31:18+01:00",
          "updated_at": "2026-05-19T18:31:18+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-19T18:31:18+01:00",
          "next_review_date": "2026-05-19T18:31:18+01:00",
          "previous_review_date": "2026-05-19T18:31:18+01:00",
          "anniversary_review_date": "2026-05-19T18:31:18+01:00",
          "terms_of_business_at": "2026-05-19T18:31:18+01:00",
          "client_agreement_at": "2026-05-19T18:31:18+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-19",
          "last_interaction_at": "2026-05-19 18:31:18",
          "referral_code": "ABC12345",
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
          "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
        },
        "account": {
          "uuid": "e97e28c8-f18e-45f5-82eb-c2fc18f32096",
          "created_at": "2026-05-19T18:31:18+01:00",
          "updated_at": "2026-05-19T18:31:18+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-19T18:31:18+01:00",
          "next_review_date": "2026-05-19T18:31:18+01:00",
          "previous_review_date": "2026-05-19T18:31:18+01:00",
          "anniversary_review_date": "2026-05-19T18:31:18+01:00",
          "terms_of_business_at": "2026-05-19T18:31:18+01:00",
          "client_agreement_at": "2026-05-19T18:31:18+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-19",
          "last_interaction_at": "2026-05-19 18:31:18",
          "referral_code": "ABC12345",
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
          "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
        },
        "accounts": [
          {
            "uuid": {
              "example": "152efae9-b608-4a45-beb7-91737489414a",
              "description": "The UUID of the resource.",
              "collection": false
            },
            "created_at": {
              "example": "2026-05-19T18:31:18+01:00",
              "description": "The timestamp of when the resource was created.",
              "collection": false
            },
            "updated_at": {
              "example": "2026-05-19T18:31:18+01:00",
              "description": "The timestamp of when the resource was updated.",
              "collection": false
            },
            "type": {
              "example": "client",
              "description": "Account type",
              "collection": false
            },
            "role": {
              "example": "client",
              "description": "Account role",
              "collection": false
            },
            "first_name": {
              "example": "Gareth",
              "description": "First name",
              "collection": false
            },
            "last_name": {
              "example": "Thompson",
              "description": "Last name",
              "collection": false
            },
            "name": {
              "example": "Gareth Thompson",
              "description": "Name",
              "collection": false
            },
            "email": {
              "example": "gareth@codepotato.co.uk",
              "description": "(Deprecated - Please use the primary email of the account instead). The email of the account.",
              "collection": false
            },
            "photo_url": {
              "example": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
              "description": "The photo URL of the client",
              "collection": false
            },
            "external_references": {
              "example": "App\\Http\\Resources\\ExternalReferenceResource",
              "description": "The external references that have been added to the client.",
              "collection": true
            }
          }
        ],
        "type": "viewed",
        "level": "info",
        "metadata": [],
        "is_impersonated": "false"
      }
    ]
  ]
}