> For the complete documentation index, see [llms.txt](https://support.pipefile.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.pipefile.com/api-reference/templates.md).

# Templates

Saved request templates you can send from. The list includes your own templates and templates shared with you by your team. Use a template's `id` with `POST /file/request/create_from_template/`.

## List templates

> Returns every template you can use, as a single unpaginated array.

```json
{"openapi":"3.0.3","info":{"title":"Pipefile API","version":"1.0"},"tags":[{"name":"Templates","description":"Saved request templates you can send from. The list includes your own\ntemplates and templates shared with you by your team. Use a template's\n`id` with `POST /file/request/create_from_template/`.\n"}],"servers":[{"url":"https://api.pipefile.com/v1","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your API key with the `Token` prefix: `Authorization: Token <your API key>`."}},"schemas":{"Template":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string","description":"Same value as `id`."},"user":{"type":"integer","description":"The owner's user ID."},"name":{"type":"string"},"is_owner":{"type":"boolean"},"shared":{"type":"boolean","description":"Shared with your team."},"locked":{"type":"boolean","description":"The template is locked against edits."},"modifiable":{"type":"boolean","description":"Whether you can edit it."},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"}}}},"public":{"type":"boolean","description":"Published to Pipefile's public template library."},"template_data":{"$ref":"#/components/schemas/TemplateData"},"lead_form_count":{"type":"integer","description":"How many lead forms use this template."}}},"TemplateData":{"type":"object","properties":{"subject":{"type":"string"},"message":{"type":"string"},"reminder_frequency":{"type":"integer"},"expiration_days":{"type":"integer","description":"Days from sending until a request made from this template expires."},"contents":{"type":"array","items":{"type":"object","description":"A template checklist item (`type` = `item`) or section (`type` = `section`).","properties":{"id":{"type":"integer"},"type":{"type":"string","enum":["item","section"]},"name":{"type":"string"},"title":{"type":"string"},"instructions":{"type":"string"},"required":{"type":"boolean"},"file_types":{"type":"array","items":{"type":"string"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}},"items":{"type":"array","items":{"type":"object"}}}}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}},"tags":{"type":"array","items":{"type":"string"}},"language":{"type":"string"},"notification_sequence":{"type":"integer","nullable":true},"storage_integration":{"type":"object","nullable":true},"destination_path":{"type":"string","nullable":true},"destination_folder_parents":{"type":"array","nullable":true,"items":{"type":"string"}},"destination_folder_id":{"type":"string","nullable":true},"destination_context":{"type":"object","nullable":true},"roles":{"type":"array","nullable":true,"description":"Signer roles defined on the template, or null.","items":{"type":"object","properties":{"role_key":{"type":"string"},"label":{"type":"string"},"color":{"type":"string"},"order_index":{"type":"integer"}}}}}},"Attachment":{"type":"object","description":"A file you attached for the recipient to see.","properties":{"attachment_id":{"type":"string"},"filename":{"type":"string"},"size":{"type":"integer","description":"Size in bytes."},"form":{"type":"object","nullable":true,"description":"The fillable form built on this attachment, if any."},"can_create_form":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"}}},"Error":{"type":"object","properties":{"detail":{"type":"string"}},"required":["detail"]}},"responses":{"Forbidden":{"description":"The API key is missing, invalid or revoked, the account is not active, or you don't have access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Throttled":{"description":"Too many calls. Wait the number of seconds in the message, then retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/file/request/templates/":{"get":{"tags":["Templates"],"operationId":"listTemplates","summary":"List templates","description":"Returns every template you can use, as a single unpaginated array.","parameters":[{"name":"search","in":"query","description":"Matches the template name.","schema":{"type":"string"}}],"responses":{"200":{"description":"Your templates.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Template"}}}}},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/Throttled"}}}}}}
```


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://support.pipefile.com/api-reference/templates.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.