GET/api/v1/email/templates

Product availabilityAlgaPSA

List email templates

Returns every notification email template available to the tenant, with the system default and the tenant override merged into one row per name and language. Use is_customized to tell which templates the tenant has edited.

RBAC · settings

Query parameters

namestringOptional

Filter to a single template name.

languagestringOptional

Filter to one language code.

categorystringOptional

Filter by notification category name.

customizedstringOptional

Filter to templates the tenant has customized (true) or not (false).

pageintegerOptional

limitintegerOptional

Response body

Success response 200 · schema PaginatedEmailTemplateEnvelope

dataarray of EmailTemplateSummaryRequired

itemsobject

One email template, system default and tenant override merged.

namestringRequired

Template name, shared by the system default and the tenant override.

language_codestringRequired

Language code of this row.

categorystringRequiredNullable

Notification category the template belongs to.

subjectstringRequired

Subject line that would be sent today.

is_customizedbooleanRequired

Whether the tenant has an override for this name and language.

system_template_idintegerRequiredNullable

tenant_template_idintegerRequiredNullable

updated_atstringRequiredNullable

When the tenant override was last written.

paginationobjectRequired

pageintegerRequired

limitintegerRequired

totalintegerRequired

totalPagesintegerRequired

hasNextbooleanRequired

hasPrevbooleanRequired

metaobject

Response codes

200

Email templates returned successfully.

401

Authentication failed.

403

Authenticated user lacks the settings read permission.

GET /api/v1/email/templates

cURL

curl -X GET "https://algapsa.com/api/v1/email/templates?name=string&language=en&category=string&customized=true&page=1&limit=1" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/email/templates?name=string&language=en&category=string&customized=true&page=1&limit=1", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/email/templates?name=string&language=en&category=string&customized=true&page=1&limit=1");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": [
    {
      "name": "string",
      "language_code": "string",
      "category": "string",
      "subject": "string",
      "is_customized": false,
      "system_template_id": 1,
      "tenant_template_id": 1,
      "updated_at": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  },
  "meta": {}
}