Create a Report Template | PlannrCRM API documentation

Create a Report Template Run in API Explorer

POST /api/v1/report-template

Personal access token & O auth2

application/json

Body

name string Required

Name of the report template
report_type_id string Required

Valid report type id, this template will generate reports of this type
report_query object

Extra query information that may be either required or optional depending on the report type

Additional properties are allowed.

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
- created_at string
- updated_at string
- name string
- created_by object
  
  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
  
  last_interaction_at string
  
  custom_fields string
  
  external_references string
- report_type_id string
- report_query object
  
  Hide report_query attribute Show report_query attribute object
  
  start_date string

POST /api/v1/report-template

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/report-template' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"Task report for clients over the age 60","report_type_id":"rmar","report_query":{"start_age":60}}'

Request examples

{
  "name": "Task report for clients over the age 60",
  "report_type_id": "rmar",
  "report_query": {
    "start_age": 60
  }
}

Response examples (200)

[
  {
    "name": "2 weeks overdue task report",
    "uuid": "11813922-8fce-400c-9e43-04240385259d",
    "created_at": "2025-12-23T11:23:58+00:00",
    "created_by": {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "f6354902-735a-486c-b957-94a791261730",
      "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-12-23T11:23:58+00:00",
      "first_name": "Gareth",
      "updated_at": "2025-12-23T11:23:58+00:00",
      "with_login": true,
      "inactive_at": "2025-12-23",
      "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-12-23T11:23:58+00:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2025-12-23T11:23:58+00:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "last_interaction_at": "2025-12-23 11:23:58",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "joint_account_circle": "App\\Http\\Resources\\CircleResource",
      "ownership_percentage": 100,
      "previous_review_date": "2025-12-23T11:23:58+00:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2025-12-23T11:23:58+00:00"
    },
    "updated_at": "2025-12-23T11:23:58+00:00",
    "report_query": {
      "start_date": "2025-12-23T11:23:58+00:00"
    },
    "report_type_id": "rmar"
  }
]