API documentation

>>>

GET /api/mail_notifications
List of email notifications

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 field and order, eg. ‘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 Validations: Must be a number.

Search fields

Field name	Type	Possible values
description	text
name	string
user	string

>>>

GET /api/mail_notifications/:id
Show an email notification

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

id
required

Numerical ID or email notification name

Validations:

Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.