Get a Report Template

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

Personal access token & O auth2

Headers

Authorization string
Content-Type string
Accept string

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
- 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

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

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/report-template/reportTemplate_uuid' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json"

Response examples (200)

{
  "name": "2 weeks overdue task report",
  "uuid": "80e199ec-663e-4542-9f4c-435a869938ae",
  "created_at": "2025-04-22T13:44:21+01:00",
  "created_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "031db4f6-c776-4aa7-b5a1-18644be3fdfd",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-22T13:44:21+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-22T13:44:21+01:00",
    "with_login": true,
    "inactive_at": "2025-04-22",
    "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-04-22T13:44:21+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-22T13:44:21+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-04-22T13:44:21+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-22T13:44:21+01:00"
  },
  "updated_at": "2025-04-22T13:44:21+01:00",
  "report_query": {
    "start_date": "2025-04-22T13:44:21+01:00"
  },
  "report_type_id": "rmar"
}