Get All Reports

GET /api/v1/report

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).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
GET /api/v1/report 
curl \
 -X GET https://api.plannrcrm.com/api/v1/report \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "data": [
    {
      "name": "rmar-report-2024-10-16T11:10:17+01:00",
      "uuid": "c47ee23c-5adb-474e-85b2-13cc37aaeb17",
      "files": [
        {
          "firm": "App\\Http\\Resources\\FirmResource",
          "name": "Welcome to Plannr",
          "size": "21691783",
          "tags": "App\\Http\\Resources\\TagResource",
          "type": "type",
          "uuid": "39a48ce8-f249-45c1-a912-d6a183f048fe",
          "parent": "Object",
          "status": "uploaded",
          "account": "App\\Http\\Resources\\AccountResource",
          "filename": "Welcome to Plannr.pdf",
          "progress": "100",
          "extension": "pdf",
          "created_at": "2024-10-16T11:10:17+01:00",
          "updated_at": "2024-10-16T11:10:17+01:00",
          "folder_name": "folder 2",
          "uploaded_at": "2024-10-16T11:10:17+01:00",
          "download_url": "https://plannr.valet/file/673c6ede-7252-4f32-bc30-780ead4f8cda/download",
          "last_modified": "2024-10-16T11:10:17+01:00",
          "original_created_at": "2024-10-16T11:10:17+01:00"
        }
      ],
      "folder": {
        "name": "Important Documents",
        "path": "Codepotato/Important Documents",
        "slug": "important-documents",
        "uuid": "ab5759a6-863a-4f31-97d9-f210ea3e2c36",
        "depth": 5,
        "files": "App\\Http\\Resources\\FileResource",
        "owned": false,
        "parent": "App\\Http\\Resources\\FolderResource",
        "folders": "App\\Http\\Resources\\FolderResource",
        "parents": "App\\Http\\Resources\\FolderResource",
        "children": "App\\Http\\Resources\\FolderResource",
        "created_at": "2024-10-16T11:10:17+01:00",
        "updated_at": "2024-10-16T11:10:17+01:00",
        "files_count": 8,
        "clients_read": true,
        "participants": "App\\Http\\Resources\\FolderParticipantResource",
        "clients_write": true,
        "folders_count": 5,
        "is_root_folder": true,
        "is_pseudo_folder": true,
        "is_system_folder": true,
        "participants_count": 3,
        "show_client_permissions": true
      },
      "status": "complete",
      "progress": 100,
      "created_at": "2024-10-16T11:10:17+01:00",
      "created_by": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "904a1cb0-a30c-4d6c-95fe-51326d25209c",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-10-16T11:10:17+01:00",
        "first_name": "Gareth",
        "updated_at": "2024-10-16T11:10:17+01: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": "2024-10-16T11:10:17+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-10-16T11:10:17+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-10-16T11:10:17+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-10-16T11:10:17+01:00"
      },
      "updated_at": "2024-10-16T11:10:17+01:00",
      "report_type_id": "rmar"
    }
  ]
}