List available OTP templates
GET /v1/templates
GET https://api.k-otp.dev/v1/templatesOverview
Returns the whitelisted message templates that POST /issue accepts via templateId, plus the default template id used when templateId is omitted. The list is small and not paginated. Every template body contains the #{code} placeholder; new templates are registered operationally, not through the API.
Requires an sk_ secret key; pk_ public keys are rejected with 403.
Authentication
| Accepted keys | Required scope | Also accepted |
|---|---|---|
sk_ | otp:templates | otp:read, * |
Response (200)
All available templates.
| Field | Type | Required | Description |
|---|---|---|---|
defaultTemplateId | string | yes | Template used when POST /v1/issue omits templateId. |
templates | object[] | yes | |
note | string | yes | Human-readable policy note. |
Error responses
Every error uses the { defined, code, status, message, data? } envelope. See Errors.
| Status | code | Description |
|---|---|---|
| 400 | BAD_REQUEST | the request failed input validation. message describes the first failing constraint. |
| 401 | UNAUTHORIZED | the Authorization: Bearer credential is missing, malformed, inactive, or rejected by introspection. |
| 403 | FORBIDDEN | the credential lacks otp:templates (or an accepted alias), or a pk_ public key was used. Public keys are limited to issue/verify. |
| 409 | CONFLICT | the request conflicts with the current state of the resource. |
| 500 | INTERNAL_SERVER_ERROR | unexpected server failure. Undefined errors (defined: false) use the same envelope. |
| 503 | SERVICE_UNAVAILABLE | credential introspection or a downstream dependency is temporarily unavailable. Retry with backoff. |
Example request
curl "https://api.k-otp.dev/v1/templates" \
-H "Authorization: Bearer $KOTP_SECRET_KEY"