Get Report

GET /api/v1/report/{uuid}

Path parameters

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.

    • name string

      Name of the report

    • created_by object

      the account that created this report

    • 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

    • folder object

      Folder generated with the report. this is the default folder that all generated documents will be stored
GET /api/v1/report/{uuid} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/report/uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "name": "rmar-report-2024-10-16T11:10:17+01:00",
  "uuid": "de189e79-4693-404e-991c-d0d1954aabdd",
  "files": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Welcome to Plannr",
      "size": "21691783",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "type",
      "uuid": "beb37b8d-85f1-4314-b799-e609efbf7620",
      "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/3017bf05-518a-4d97-964f-0fac379fb241/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": "ba7bb2cf-0136-4771-bf66-d104cd479ecd",
    "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": "839d0df0-7c35-4fb5-8168-cd41292f1737",
    "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"
}