How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GOV.UK Notify Templates API

Retrieve and preview notification templates

GOV.UK Notify Templates API is one of 9 APIs that GOV.UK Notify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Templates. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.notifications.service.gov.uk.

4 operations 4 paths 5 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.notifications.service.gov.uk
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GOV.UK Notify Templates API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — JWT token signed with HS256 using the service API key secret. Tokens are short-lived and must include iss (service ID), iat (issued at), and exp (expiry) claim…

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Templates 4

Retrieve and preview notification templates

GET
/v2/template/{template_id}
Get template by ID
getTemplate 1 param → 200403404500
GET
/v2/template/{template_id}/version/{version}
Get template by ID and version
getTemplateVersion 2 params → 200403404500
GET
/v2/templates
List all templates
listTemplates 1 param → 200403500
POST
/v2/template/{template_id}/preview
Generate a template preview
previewTemplate 1 param body → 200400403404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Template (12 properties), TemplatePreview (7 properties), ErrorResponse (2 properties), TemplateList (1 property). Each schema is shown below with its type and property counts.

ErrorResponse
object
2 properties
TemplatePreview
object
7 properties
Template
object
12 properties
TemplatePreviewRequest
object
1 property 1 required
TemplateList
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gov-uk-notify-templates-api-openapi.yml Raw ↑

Other APIs GOV.UK Notify publishes across the network.

GOV.UK Notify Python Client
GOV.UK Notify Java Client
GOV.UK Notify .NET Client
GOV.UK Notify Node.js Client
GOV.UK Notify PHP Client
GOV.UK Notify Ruby Client
GOV.UK Notify Notifications API
GOV.UK Notify Received Text Messages API
Where this information came from

This is an independent, third-party profile of GOV.UK Notify Templates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.