curl --request GET \ --url 'https://app.output.rocks/api/spa/email-templates?page=1&itemsPerPage=20&order%5Bid%5D=asc&order%5Bidentifier%5D=asc&order%5BactiveFrom%5D=asc&order%5Bactive%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc&order%5Bpaused%5D=asc' \ --header 'X-AUTH-TOKEN: <api-key>'

[ { "id": 12345, "identifier": "key1", "description": "Invoice for contract <<contract.number>>", "color": "#083E5D", "maxBlockedAmount": 10, "paused": false, "customId": "<<contract.id>>", "createdAt": "2024-08-23T00:00:00+00:00", "updatedAt": "2024-08-23T00:00:00+00:00", "brandIdentifier": "default", "active": true, "activeFrom": "2024-01-01", "groupIdentifier": "my_group", "groupCondition": "data['contract']['balance'] > 0", "reviewCondition": "data['contract']['id'] > 1000", "subClientDefault": false, "subClientId": 3, "subClientDescription": "Branch Office A" } ]

SPA Email Templates

SPA: Retrieves a paginated list of Email Templates

Returns a paginated list of email templates for the authenticated user's client.

GET/api/spa/email-templates

SPA: Retrieves a paginated list of Email Templates

curl --request GET \
  --url 'https://app.output.rocks/api/spa/email-templates?page=1&itemsPerPage=20&order%5Bid%5D=asc&order%5Bidentifier%5D=asc&order%5BactiveFrom%5D=asc&order%5Bactive%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc&order%5Bpaused%5D=asc' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 12345,
    "identifier": "key1",
    "description": "Invoice for contract <<contract.number>>",
    "color": "#083E5D",
    "maxBlockedAmount": 10,
    "paused": false,
    "customId": "<<contract.id>>",
    "createdAt": "2024-08-23T00:00:00+00:00",
    "updatedAt": "2024-08-23T00:00:00+00:00",
    "brandIdentifier": "default",
    "active": true,
    "activeFrom": "2024-01-01",
    "groupIdentifier": "my_group",
    "groupCondition": "data['contract']['balance'] > 0",
    "reviewCondition": "data['contract']['id'] > 1000",
    "subClientDefault": false,
    "subClientId": 3,
    "subClientDescription": "Branch Office A"
  }
]

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

page

integerdefault:1

The collection page number

itemsPerPage

integerdefault:20

The number of items per page

pagination

boolean

Enable or disable pagination

order[id]

stringdefault:asc

No description provided.

order[identifier]

stringdefault:asc

No description provided.

order[activeFrom]

stringdefault:asc

No description provided.

order[active]

stringdefault:asc

No description provided.

order[createdAt]

stringdefault:asc

No description provided.

order[updatedAt]

stringdefault:asc

No description provided.

order[paused]

stringdefault:asc

No description provided.

identifier

string

No description provided.

brandIdentifier

string

No description provided.

brandIdentifier[]

string[]

No description provided.

string

Search across multiple fields (id, identifier, brandIdentifier, description, groupIdentifier, customId, color, maxBlockedAmount, paused, bounceHandling, validatorIdentifiers, activeFrom, active, subClientDefault, createdAt, updatedAt, subClient.description) using OR logic with partial matching.

active

boolean

No description provided.

activeFrom[before]

string

No description provided.

activeFrom[strictly_before]

string

No description provided.

activeFrom[after]

string

No description provided.

activeFrom[strictly_after]

string

No description provided.

Response

200application/json

EmailTemplate collection

integer

Identifier generated by Output.Rocks.

Example: 12345

identifier

stringrequired

Unique identifier

Example: "key1"

description

string

EmailTemplate description / title. <<>>-Syntax can be used for dynamical generation.

Example: "Invoice for contract <<contract.number>>"

color

string

HTML color code to be used on Dashboard-charts and statistics.

Example: "#083E5D"

maxBlockedAmount

integer

Maximum amount of accepted errors. EmailTemplate will be paused in case of reaching this limit

Example: 10

paused

boolean

Paused flag. Default: false

Available options: truefalse

Example: false

customId

string

Optional value in <<>>-Syntax to be extracted and stored on each rendered document.

Example: "<<contract.id>>"

createdAt

string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt

string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

brandIdentifier

stringrequired

Example: "default"

active

boolean

Active flag. Default: true

Available options: truefalse

Example: true

activeFrom

string<date-time>

Date to activate the entry. Default: today

Example: "2024-01-01"

groupIdentifier

string

Optional group identifier to be used with group conditions

Example: "my_group"

groupCondition

string

Group condition.

Example: "data['contract']['balance'] > 0"

reviewCondition

string

Review condition.

Example: "data['contract']['id'] > 1000"

subClientDefault

boolean

Default for environmental tenants (sub-clients)

Available options: truefalse

Example: false

subClientId

integer

SubClient ID. Provided on instances with enabled sub-client module only.

Example: 3

subClientDescription

string

SubClient description. Provided on instances with enabled sub-client module only.

Example: "Branch Office A"