Get Report

GET /api/v1/report/{uuid}

Path parameters

uuid string Required

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.
- last_interaction_at string
  
  Last interaction date of an account associated with this report
- last_login_at string
  
  Last login date of an account associated with this report
- name string
  
  Name of the report
- created_by object
  
  the account that created this report
  
  Hide created_by attributes Show created_by 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
  
  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
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
- report_type_id string
  
  report type id
- status string
  
  Current status of report generation
- progress integer
  
  Current progress of the report when generating
- files array[object]
  
  Files generated for this report instance
  
  Hide files attributes Show files attributes object
  
  uuid string
  
  created_at string
  
  original_created_at string
  
  updated_at string
  
  uploaded_at string
  
  status string
  
  filename string
  
  name string
  
  extension string
  
  type string
  
  size string
  
  path string
  
  last_modified string
  
  progress string
  
  download_url string
  
  folder_name string
  
  folder string
  
  documentable_type string
  
  documentable string
  
  navigator object
  
  Hide navigator attributes Show navigator attributes object
  
  model_type string
  
  model_uuid string
  
  firm string
  
  account string
  
  tags string
- folder object
  
  Folder generated with the report. this is the default folder that all generated documents will be stored
  
  Hide folder attributes Show folder attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  path string
  
  clients_read boolean
  
  clients_write boolean
  
  show_client_permissions boolean
  
  is_system_folder boolean
  
  is_pseudo_folder boolean
  
  is_root_folder boolean
  
  documentable_type string
  
  documentable_uuid string
  
  documentable string
  
  participants_count integer
  
  participants string
  
  folders_count integer
  
  folders string
  
  files_count integer
  
  files string
  
  parents string
  
  ancestors string
  
  children string
  
  depth integer
  
  owned boolean

GET /api/v1/report/{uuid}

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/report/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "name": "rmar-report-2025-08-27T17:31:27+01:00",
  "uuid": "a3896107-1943-43c8-b9b2-767871402266",
  "files": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Welcome to Plannr",
      "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
      "size": "21691783",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "type",
      "uuid": "24040244-42e6-467b-8d6e-1b6fff109574",
      "folder": "App\\Http\\Resources\\FolderResource",
      "status": "uploaded",
      "account": "App\\Http\\Resources\\MinimalAccountResource",
      "filename": "Welcome to Plannr.pdf",
      "progress": "100",
      "extension": "pdf",
      "navigator": {
        "model_type": "account",
        "model_uuid": "739ed8f4-4c76-498b-88bd-eecc1eaf5c48"
      },
      "created_at": "2025-08-27T17:31:27+01:00",
      "updated_at": "2025-08-27T17:31:27+01:00",
      "folder_name": "folder 2",
      "uploaded_at": "2025-08-27T17:31:27+01:00",
      "documentable": "Object",
      "download_url": "https://api.plannrcrm.com/file/bb688a84-6bc1-4c76-8301-c08b516ee9f3/download",
      "last_modified": "2025-08-27T17:31:27+01:00",
      "documentable_type": "account",
      "original_created_at": "2025-08-27T17:31:27+01:00"
    }
  ],
  "folder": {
    "name": "Important Documents",
    "path": "Codepotato/Important Documents",
    "slug": "important-documents",
    "uuid": "fb27cdd9-20a9-4514-905b-6925bb27d51e",
    "depth": 5,
    "files": "App\\Http\\Resources\\FileResource",
    "owned": false,
    "folders": "App\\Http\\Resources\\FolderResource",
    "parents": "App\\Http\\Resources\\FolderResource",
    "children": "App\\Http\\Resources\\FolderResource",
    "ancestors": "App\\Http\\Resources\\FolderResource",
    "created_at": "2025-08-27T17:31:27+01:00",
    "updated_at": "2025-08-27T17:31:27+01:00",
    "files_count": 8,
    "clients_read": true,
    "documentable": "Object",
    "participants": "App\\Http\\Resources\\FolderParticipantResource",
    "clients_write": true,
    "folders_count": 5,
    "is_root_folder": true,
    "is_pseudo_folder": true,
    "is_system_folder": true,
    "documentable_type": "account",
    "documentable_uuid": "account",
    "participants_count": 3,
    "show_client_permissions": true
  },
  "status": "complete",
  "progress": 100,
  "created_at": "2025-08-27T17:31:27+01:00",
  "created_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "06a8bdeb-328e-4c47-aa3f-c8fb19058d58",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2025-08-27T17:31:27+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-08-27T17:31:27+01:00",
    "with_login": true,
    "inactive_at": "2025-08-27",
    "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-08-27T17:31:27+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-08-27T17:31:27+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-08-27T17:31:27+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-08-27T17:31:27+01:00"
  },
  "updated_at": "2025-08-27T17:31:27+01:00",
  "last_login_at": "2024-01-24T09:15:00Z",
  "report_type_id": "rmar",
  "last_interaction_at": "2024-01-24T10:30:00Z"
}