> For the complete documentation index, see [llms.txt](https://docs.getgophish.com/python-api-client/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.getgophish.com/python-api-client/templates.md). # Templates Templates are the emails that are sent out by Gophish during a campaign. The templates endpoint allows you to create, view, and manage Gophish templates. ## Table of Contents * [Quick Example](/python-api-client/templates.md#quick-example) * [Models](/python-api-client/templates.md#models) * [Methods](/python-api-client/templates.md#methods) * [Examples](/python-api-client/templates.md#examples) ## Quick Example This example shows how to retrieve the name of every template in Gophish. ```python from gophish import Gophish api_key = 'API_KEY' api = Gophish(api_key) for template in api.templates.get(): print template.name ``` ### Models #### gophish.models.Attachment **Attributes** * `content` (str) The base64 encoded attachment content * `type` (str) The content type of the attachment * `name` (str) The attachment filename **Methods** * `__init__(self, **kwargs)` - Returns a new Attachment Example: ```python todo ``` #### gophish.models.Template A template contains a name and the email content. **Attributes** * `id` (int) The template ID * `name` (str) The template name * `html` (str) The template HTML * `text` (str) The template HTML * `modified_date` (optional: datetime.datetime) The scheduled time for template launch * `attachments` (list(models.Attachment)) The optional email attachments **Methods** * `__init__(self, **kwargs)` - Returns a new Template Example: ```python from gophish.models import * template = Template(name='Test Template', html="Click here) ``` ### Methods #### gophish.api.templates.get(template\_id=None) Gets the details for one or more templates. To get a particular template, set the ID to the template ID. If the `template_id` is not set, all templates owned by the current user will be returned. **Returns** * If the `template` is set: `models.Template` * If `template_id` is `None`: `list(models.Template)` #### gophish.api.templates.post(template) Creates a new template. This endpoint requires you to submit a `gophish.models.Template` object. **Returns** The `gophish.models.Template` object that was created. #### gophish.api.templates.put(template) Edits an existing template. This endpoint requires you to submit an existing `gophish.models.Template` object with its `id` attribute set correctly. **Returns** The `gophish.models.Template` object that was edited. #### gophish.api.templates.delete(template\_id) Deletes the template specified by `template_id`. **Returns** A `gophish.models.Status` message. ### Examples Here are some examples to show how to use the API. All of these examples assume the following setup: ```python from gophish import Gophish from gophish.models import * api_key = 'API_KEY' api = Gophish(api_key) ``` #### Get All Templates ```python templates = api.templates.get() ``` #### Get Single Template ```python template = api.templates.get(template_id=1) ``` #### Create New Template ```python template = Template(name='Test Template', html='Click here') template = api.templates.post(template) print template.id ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.getgophish.com/python-api-client/templates.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.