Get a Report Template

GET /api/v1/report-template/{reportTemplate_uuid}

Path parameters

reportTemplate_uuid string Required

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 template
- created_by object
  
  The account that created this report template
  
  Hide created_by attributes Show created_by attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
- report_type_id string
  
  Report type id of the report type to generate when using this template
- report_query object
  
  Extra query information that will be used in generating the report
  
  Hide report_query attribute Show report_query attribute object
  
  start_date string

GET /api/v1/report-template/{reportTemplate_uuid}

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/report-template/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "name": "2 weeks overdue task report",
  "uuid": "c50194e2-e302-4d49-8a3f-0ff7bde1546f",
  "created_at": "2025-08-07T13:41:46+01:00",
  "created_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "519757f2-cc90-4ca7-b927-ec596cfce9ae",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2025-08-07T13:41:46+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-08-07T13:41:46+01:00",
    "with_login": true,
    "inactive_at": "2025-08-07",
    "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-08-07T13:41:46+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-08-07T13:41:46+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-08-07T13:41:46+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-08-07T13:41:46+01:00"
  },
  "updated_at": "2025-08-07T13:41:46+01:00",
  "report_query": {
    "start_date": "2025-08-07T13:41:46+01:00"
  },
  "report_type_id": "rmar"
}