Templates
List templates
Returns communication templates for the company. All filter parameters are optional.
Accepts an API key (x-token), delegate token (Authorization: DelegateToken <token>), or partner token (Authorization: Bearer <token> with templates permission). When using a partner token, pass companyId as a query parameter.
get/api/templates
Request
- Base URLhttps://core-api.getaptly.com
- Auth
- API key in header x-token
- or API key in header Authorization
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
companyIdstring
Company ID. Required when using a partner token; resolved automatically for API key and delegate token auth.
templateType'sms' | 'email' | 'form' | 'eSignature' | 'pdf' | 'blockDocument'
Filter by template type.
aptletUuidstring
Filter by associated board UUID.
archivedboolean
Filter by archived status.
Response
Array of templates.
Changes
No recorded changes to this operation across all 1 revision of this API.