Templates

Get a template

Returns the template with its project entry path, delivery defaults, compiled channel content, current publication, and the input schema that publication validates against. Open live project files through the workspace API.

get/v1/templates/{id}

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/templates/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Response

Template

idstring required
slugstring required
namestring required
channel'email' required
projectIdstring required
namespaceIdstring required
sharedboolean required

Whether the template's project is shared with every namespace. Every entry in a project shares it. A namespace-scoped key reads and sends a shared template in its own namespace but cannot change it. Only an organization-level project is shared.

entryPathstring required
status'draft' | 'pending' | 'approved' | 'published' | 'rejected' | 'archived' required
isActiveboolean required
publishedAtstring nullable required
usageCountinteger required
lastUsedAtstring nullable required
createdAtstring required
updatedAtstring required
familyIdstring required
descriptionstring nullable required
category'transactional' | 'marketing' | 'support' | 'notification' | 'verification' | 'reminder' | 'alert' nullable required
replyToDefaultstring[] nullable required
publicationIdstring required
inputContractIdstring required
inputSchemaobject nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.