Headers
-
Content-Type string
-
Accept string
Query parameters
-
filter[uuid] string
Filter by a comma separated list of UUIDs.
-
filter[report_type_id] string
Exact filter for type of report to return
-
filter[created_by] string
list of adviser uuids to filter reports created by these accounts
-
sort string
Field to sort by. Valid fields are [updated_at, created_at, name, report_type_id]. Negative sign to denote DESC. Defaults to '-created_at'.
-
per_page integer
Number of results to return with pagination (Default 15. Max 500).
GET
/api/v1/report
curl \
--request GET https://api.plannrcrm.com/api/v1/report \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Response examples (200)
{
"data": [
{
"name": "rmar-report-2025-02-20T10:13:06+00:00",
"uuid": "a7259fa0-6438-4db5-b612-45546f4826f2",
"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": "dc45cfe2-ef8f-481d-832b-f8d04ffeeb2f",
"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": "3f8811e2-2438-4ac6-ad22-0ea07fe37c6a"
},
"created_at": "2025-02-20T10:13:06+00:00",
"updated_at": "2025-02-20T10:13:06+00:00",
"folder_name": "folder 2",
"uploaded_at": "2025-02-20T10:13:06+00:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/fb2e3a98-c2a4-4293-9689-412f88b78013/download",
"last_modified": "2025-02-20T10:13:06+00:00",
"documentable_type": "account",
"original_created_at": "2025-02-20T10:13:06+00:00"
}
],
"folder": {
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "057a916e-e8d1-4803-ae82-263d1a207e3a",
"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-02-20T10:13:06+00:00",
"updated_at": "2025-02-20T10:13:06+00: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-02-20T10:13:06+00:00",
"created_by": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "e5f26bd4-cac6-46d5-a99c-9bd1bbfd9fb9",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-02-20T10:13:06+00:00",
"first_name": "Gareth",
"updated_at": "2025-02-20T10:13:06+00:00",
"with_login": true,
"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-02-20T10:13:06+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-02-20T10:13:06+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-02-20T10:13:06+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-02-20T10:13:06+00:00"
},
"updated_at": "2025-02-20T10:13:06+00:00",
"report_type_id": "rmar"
}
]
}