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-04-02T13:27:58+01:00",
"uuid": "90605f1c-496b-44d4-a605-8f74e645fb4f",
"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": "eacf2a9b-da87-4a43-a6cf-9a783afb1f43",
"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": "c1b22533-f76f-4e0a-9f46-791eac9c4334"
},
"created_at": "2025-04-02T13:27:58+01:00",
"updated_at": "2025-04-02T13:27:58+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-04-02T13:27:58+01:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/7767f214-252b-43f8-8a65-a231b9f9c359/download",
"last_modified": "2025-04-02T13:27:58+01:00",
"documentable_type": "account",
"original_created_at": "2025-04-02T13:27:58+01:00"
}
],
"folder": {
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "34fe7b07-cbea-4ef3-9cc4-cdd16ffb5ff7",
"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-04-02T13:27:58+01:00",
"updated_at": "2025-04-02T13:27:58+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-04-02T13:27:58+01:00",
"created_by": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "4200d995-69e9-4ac8-b73a-5b09d0b7f1bd",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-02T13:27:58+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-02T13:27:58+01:00",
"with_login": true,
"inactive_at": "2025-04-02",
"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-04-02T13:27:58+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-02T13:27:58+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-04-02T13:27:58+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-02T13:27:58+01:00"
},
"updated_at": "2025-04-02T13:27:58+01:00",
"report_type_id": "rmar"
}