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
  
  business_unit 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
  
  referral_code string
  
  permissions object
  
  Hide permissions attributes Show permissions attributes object
  
  firm:read array[string]
  
  network:read array[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)

{
  "uuid": "4e07bb6d-70e3-4a62-972f-a93f6077070c",
  "created_at": "2026-04-24T17:14:54+01:00",
  "updated_at": "2026-04-24T17:14:54+01:00",
  "name": "2 weeks overdue task report",
  "created_by": {
    "uuid": "527a69ec-68c4-4c61-8342-b937a05a76e7",
    "created_at": "2026-04-24T17:14:54+01:00",
    "updated_at": "2026-04-24T17:14:54+01:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "firm": "App\\Http\\Resources\\FirmResource",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
    "groups": "App\\Http\\Resources\\GroupResource",
    "tags": "App\\Http\\Resources\\TagResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "first_contact_date": "2026-04-24T17:14:54+01:00",
    "next_review_date": "2026-04-24T17:14:54+01:00",
    "previous_review_date": "2026-04-24T17:14:54+01:00",
    "anniversary_review_date": "2026-04-24T17:14:54+01:00",
    "with_login": true,
    "has_joint_account": true,
    "can_be_deleted": "false",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "inactive_at": "2026-04-24",
    "last_interaction_at": "2026-04-24 17:14:54",
    "referral_code": "ABC12345",
    "permissions": {
      "firm:read": [
        "firm"
      ],
      "network:read": [
        "network:uuid"
      ]
    },
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "report_type_id": "rmar",
  "report_query": {
    "start_date": "2026-04-24T17:14:54+01:00"
  }
}