Get Report Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
"PlannrCRM MCP server": {
  "url": "https://apidocs.plannrcrm.com/mcp"
}
Close
GET /api/v1/report/{uuid}
Personal access token & O auth2

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
      • 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
    • 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) 
{
  "uuid": "b2711146-9396-454a-9bf6-ec7d4044ffed",
  "created_at": "2026-06-12T16:03:58+01:00",
  "updated_at": "2026-06-12T16:03:58+01:00",
  "last_interaction_at": "2024-01-24T10:30:00Z",
  "last_login_at": "2024-01-24T09:15:00Z",
  "name": "rmar-report-2026-06-12T16:03:58+01:00",
  "created_by": {
    "uuid": "383a787c-7a01-4251-a948-d611fb5d2fa0",
    "created_at": "2026-06-12T16:03:58+01:00",
    "updated_at": "2026-06-12T16:03:58+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-06-12T16:03:58+01:00",
    "next_review_date": "2026-06-12T16:03:58+01:00",
    "previous_review_date": "2026-06-12T16:03:58+01:00",
    "anniversary_review_date": "2026-06-12T16:03:58+01:00",
    "terms_of_business_at": "2026-06-12T16:03:58+01:00",
    "client_agreement_at": "2026-06-12T16:03:58+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-06-12",
    "last_interaction_at": "2026-06-12 16:03:58",
    "referral_code": "ABC12345",
    "permissions": {
      "firm:read": [
        "firm"
      ],
      "network:read": [
        "network:uuid"
      ]
    },
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "report_type_id": "rmar",
  "status": "complete",
  "progress": 100,
  "files": [
    {
      "uuid": "65841763-85a5-43b3-a6be-31bc78016d1c",
      "created_at": "2026-06-12T16:03:58+01:00",
      "original_created_at": "2026-06-12T16:03:58+01:00",
      "updated_at": "2026-06-12T16:03:58+01:00",
      "uploaded_at": "2026-06-12T16:03:58+01:00",
      "status": "uploaded",
      "filename": "Welcome to Plannr.pdf",
      "name": "Welcome to Plannr",
      "extension": "pdf",
      "type": "type",
      "size": "21691783",
      "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
      "last_modified": "2026-06-12T16:03:58+01:00",
      "progress": "100",
      "download_url": "https://api.plannrcrm.com/file/cb4b38fc-9ae9-4c01-b1c6-6f0cd4a6b6d3/download",
      "folder_name": "folder 2",
      "folder": "App\\Http\\Resources\\FolderResource",
      "documentable_type": "account",
      "documentable": "Object",
      "navigator": {
        "model_type": "account",
        "model_uuid": "4de4aa49-99e2-4fde-8f7b-256443a94ee3"
      },
      "firm": "App\\Http\\Resources\\FirmResource",
      "account": "App\\Http\\Resources\\MinimalAccountResource",
      "tags": "App\\Http\\Resources\\TagResource"
    }
  ],
  "folder": {
    "uuid": "1722c050-55be-4e90-acd7-afa9de16db75",
    "created_at": "2026-06-12T16:03:58+01:00",
    "updated_at": "2026-06-12T16:03:58+01:00",
    "name": "Important Documents",
    "slug": "important-documents",
    "path": "Codepotato/Important Documents",
    "clients_read": true,
    "clients_write": true,
    "show_client_permissions": true,
    "is_system_folder": true,
    "is_pseudo_folder": true,
    "is_root_folder": true,
    "documentable_type": "account",
    "documentable_uuid": "account",
    "documentable": "Object",
    "participants_count": 3,
    "participants": "App\\Http\\Resources\\FolderParticipantResource",
    "folders_count": 5,
    "folders": "App\\Http\\Resources\\FolderResource",
    "files_count": 8,
    "files": "App\\Http\\Resources\\FileResource",
    "parents": "App\\Http\\Resources\\FolderResource",
    "ancestors": "App\\Http\\Resources\\FolderResource",
    "children": "App\\Http\\Resources\\FolderResource",
    "depth": 5,
    "owned": false
  }
}