Headers
-
Content-Type
string -
Accept
string
Path parameters
-
uuid
integer Required
GET
/api/v1/report/{uuid}
curl \
--request GET 'https://api.plannrcrm.com/api/v1/report/uuid' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Response examples (200)
{
"name": "rmar-report-2025-06-04T16:49:38+01:00",
"uuid": "60c579f4-ceca-4dba-936e-2f03fd701779",
"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": "65cda9ab-44e2-4d4d-ba6a-7590014598b8",
"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": "73a96b18-8374-4668-8de6-09e608f9b477"
},
"created_at": "2025-06-04T16:49:38+01:00",
"updated_at": "2025-06-04T16:49:38+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-06-04T16:49:38+01:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/03145de9-5cb2-4fed-bbb3-7f1a22dabde9/download",
"last_modified": "2025-06-04T16:49:38+01:00",
"documentable_type": "account",
"original_created_at": "2025-06-04T16:49:38+01:00"
}
],
"folder": {
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "b03250c3-a992-4dc4-a1de-15ead881beb4",
"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-06-04T16:49:38+01:00",
"updated_at": "2025-06-04T16:49:38+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-06-04T16:49:38+01:00",
"created_by": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "585ad1b5-35c9-49c7-9851-c57740182702",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-06-04T16:49:38+01:00",
"first_name": "Gareth",
"updated_at": "2025-06-04T16:49:38+01:00",
"with_login": true,
"inactive_at": "2025-06-04",
"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-04T16:49:38+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-06-04T16:49:38+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-04T16:49:38+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-06-04T16:49:38+01:00"
},
"updated_at": "2025-06-04T16:49:38+01:00",
"report_type_id": "rmar"
}