GET /api/report_templates
List all report templates

GET /api/locations/:location_id/report_templates
List all report templates per location

GET /api/organizations/:organization_id/report_templates
List all report templates per organization

Examples

GET /api/report_templates
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "description": null,
      "created_at": "2021-11-26 11:26:09 UTC",
      "updated_at": "2021-11-26 11:26:09 UTC",
      "name": "report_template87",
      "id": 1007981725
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort and order by a searchable field, e.g. ‘id DESC’

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
default true, false
location string
location_id integer
locked true, false
name string
organization string
organization_id integer
snippet true, false
template text