Get all Report Templates

GET /api/v1/report-template

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

Comma separated 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 'name'.
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
- data array[object]
  
  Hide data attributes Show data 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
  
  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
  
  ownership_percentage integer
  
  inactive_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

GET /api/v1/report-template

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/report-template' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": [
    {
      "name": "2 weeks overdue task report",
      "uuid": "8acf0ea5-b1b8-4626-b350-381b6529d1bf",
      "created_at": "2025-06-26T11:37:10+01:00",
      "created_by": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "ed9167ef-4904-4ff6-aa02-4c0da269e62c",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-06-26T11:37:10+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-26T11:37:10+01:00",
        "with_login": true,
        "inactive_at": "2025-06-26",
        "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-06-26T11:37:10+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-06-26T11:37:10+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-06-26T11:37:10+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-06-26T11:37:10+01:00"
      },
      "updated_at": "2025-06-26T11:37:10+01:00",
      "report_query": {
        "start_date": "2025-06-26T11:37:10+01:00"
      },
      "report_type_id": "rmar"
    }
  ]
}