Get a Report Template

GET /api/v1/report-template/{reportTemplate_uuid}
Personal access token & OAuth2

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

      Additional properties are allowed.

    • 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

      Additional properties are allowed.
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": "ec2cb9d6-f770-4fde-94b1-ba17d3e04844",
  "created_at": "2025-02-20T10:13:06+00:00",
  "created_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "3d666f11-b960-40ca-bcf1-106c73b32aa2",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-02-20T10:13:06+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-02-20T10:13:06+00:00",
    "with_login": true,
    "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-02-20T10:13:06+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-02-20T10:13:06+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-02-20T10:13:06+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-02-20T10:13:06+00:00"
  },
  "updated_at": "2025-02-20T10:13:06+00:00",
  "report_query": {
    "start_date": "2025-02-20T10:13:06+00:00"
  },
  "report_type_id": "rmar"
}