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]

      Additional properties are allowed.
GET /api/v1/report-template 
curl \
 -X GET https://api.plannrcrm.com/api/v1/report-template \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "data": [
    {
      "name": "2 weeks overdue task report",
      "uuid": "a8250bba-caba-436d-acfc-d4bd4d9ce2c4",
      "created_at": "2024-11-20T13:24:04+00:00",
      "created_by": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "abba1ae5-e084-40f1-81d9-753dce229b64",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-11-20T13:24:04+00:00",
        "first_name": "Gareth",
        "updated_at": "2024-11-20T13:24:04+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": "2024-11-20T13:24:04+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-11-20T13:24:04+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-11-20T13:24:04+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-11-20T13:24:04+00:00"
      },
      "updated_at": "2024-11-20T13:24:04+00:00",
      "report_query": {
        "start_date": "2024-11-20T13:24:04+00:00"
      },
      "report_type_id": "rmar"
    }
  ]
}