API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

notification_emailtemplates

Retrieves the collection of notification_emailtemplates resources.

Retrieves the collection of notification_emailtemplates resources.

Authorizations:
JWT
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

exists[language]
boolean
exists[subject]
boolean
exists[goal]
boolean
exists[copyCarbon]
boolean
exists[blindCopyCarbon]
boolean
exists[sender]
boolean
exists[emailKey]
boolean
exists[entityName]
boolean
exists[entityReceiver]
boolean
exists[deletedAt]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
properties[]
Array of strings

Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

enabled
boolean

Filter entities by enabled (1), disabled (0), or all (nothing).

search
string
tag
string

Filter using tag.

order[subject]
string
Default: "asc"
Enum: "asc" "desc"
order[goal]
string
Default: "asc"
Enum: "asc" "desc"
order[copyCarbon]
string
Default: "asc"
Enum: "asc" "desc"
order[blindCopyCarbon]
string
Default: "asc"
Enum: "asc" "desc"
order[sender]
string
Default: "asc"
Enum: "asc" "desc"
order[emailKey]
string
Default: "asc"
Enum: "asc" "desc"
order[entityName]
string
Default: "asc"
Enum: "asc" "desc"
order[entityReceiver]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[message]
string
Default: "asc"
Enum: "asc" "desc"
order[note]
string
Default: "asc"
Enum: "asc" "desc"
order[criteria]
string
Default: "asc"
Enum: "asc" "desc"
order[sendingDelay]
string
Default: "asc"
Enum: "asc" "desc"
order[deletedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[createdAt]
string
Default: "asc"
Enum: "asc" "desc"
order[updatedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[disabledAt]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
attachFile
string
attachFile[]
Array of strings
blindCopyCarbon_end_with
string
blindCopyCarbon_partial
string
blindCopyCarbon_start_with
string
blindCopyCarbon
string
blindCopyCarbon[]
Array of strings
copyCarbon_end_with
string
copyCarbon_partial
string
copyCarbon_start_with
string
copyCarbon
string
copyCarbon[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
criteria_end_with
string
criteria_partial
string
criteria_start_with
string
criteria
string
criteria[]
Array of strings
deletedAt[before]
string
deletedAt[strictly_before]
string
deletedAt[after]
string
deletedAt[strictly_after]
string
disabledAt[before]
string
disabledAt[strictly_before]
string
disabledAt[after]
string
disabledAt[strictly_after]
string
emailKey_end_with
string
emailKey_partial
string
emailKey_start_with
string
emailKey
string
emailKey[]
Array of strings
entityName_end_with
string
entityName_partial
string
entityName_start_with
string
entityName
string
entityName[]
Array of strings
entityReceiver_end_with
string
entityReceiver_partial
string
entityReceiver_start_with
string
entityReceiver
string
entityReceiver[]
Array of strings
goal_end_with
string
goal_partial
string
goal_start_with
string
goal
string
goal[]
Array of strings
id_range[between]
string
id_range[gt]
string
id_range[gte]
string
id_range[lt]
string
id_range[lte]
string
id
integer
id[]
Array of integers
language
string
language[]
Array of strings
message_end_with
string
message_partial
string
message_start_with
string
message
string
message[]
Array of strings
note_end_with
string
note_partial
string
note_start_with
string
note
string
note[]
Array of strings
sender_end_with
string
sender_partial
string
sender_start_with
string
sender
string
sender[]
Array of strings
sendingDelay_range[between]
string
sendingDelay_range[gt]
string
sendingDelay_range[gte]
string
sendingDelay_range[lt]
string
sendingDelay_range[lte]
string
sendingDelay
string
sendingDelay[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
subject_end_with
string
subject_partial
string
subject_start_with
string
subject
string
subject[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}