---
title: List
url: https://www.tines.com/docs/api/admin/templates/list/
updated: 2026-05-18T15:12:49+00:00
description: Retrieve a list of private templates. Optionally search to filter results.
---

*[tines.com](https://www.tines.com/llms.txt) › [Docs](https://www.tines.com/llms.txt) › [Tines API](https://www.tines.com/llms.txt) › [Admin](https://www.tines.com/llm/docs/api/admin.md) › [Templates](https://www.tines.com/llm/docs/api/admin/templates.md)*

# List

*[View on tines.com](https://www.tines.com/docs/api/admin/templates/list/)*

## Description

Retrieve a list of private templates. Optionally search to filter results.

## Request

HTTP Method: **GET**

| Parameter | Description                                                                                                              |
| --------- | ------------------------------------------------------------------------------------------------------------------------ |
| per_page  | **Optional** Set the number of results returned per page. Defaults to 20.                                                |
| page      | **Optional** Specify the page of results to return if there are multiple pages. Defaults to page 1.                      |
| search    | **Optional** A search query to filter templates. Matches against name, description, vendor, product, and action options. |
| folder_id | **Optional** Filter templates by folder. Only returns templates in the specified folder.                                 |

### List all templates

```bash
curl -X GET \
  https://<tenant-domain>/api/v1/admin/templates \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'
```

### Search templates

```bash
curl -X GET \
  https://<tenant-domain>/api/v1/admin/templates \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{"search": "Test"}'
```

### List templates in a folder

```bash
curl -X GET \
  https://<tenant-domain>/api/v1/admin/templates?folder_id=<<folder_id>> \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'
```

## Response

A successful request will return a JSON Array of private templates in the Tines tenant.

### Field description

| Parameter         | Description                                                                                                   |
| ----------------- | ------------------------------------------------------------------------------------------------------------- |
| id                | Template ID.                                                                                                  |
| name              | Template name.                                                                                                |
| description       | Template description.                                                                                         |
| agent_type        | Type of action associated with the template.                                                                  |
| agent_options     | Action options.                                                                                               |
| vendor            | Vendor name.                                                                                                  |
| product           | Product name.                                                                                                 |
| team_id           | ID of team to which the template belongs.                                                                     |
| folder_id         | ID of the folder containing the template, or `null` if the template is not in a folder.                       |
| read_access       | Control where this template can be used (`TEAM`, `GLOBAL`, `SPECIFIC_TEAMS`).                                 |
| shared_team_slugs | List of teams' slugs where this template can be used when `read_access` is `SPECIFIC_TEAMS`, otherwise empty. |
| action_inputs     | **Optional** Array of input parameters for the template. See details below.                                   |

### action_inputs structure

Each object in the `action_inputs` array can have the following fields:

| Field         | Description                                                                                                     |
| ------------- | --------------------------------------------------------------------------------------------------------------- |
| name          | **Required** Input parameter name.                                                                              |
| type          | **Required** Input type. One of: `TEXT`, `NUMBER`, `BOOLEAN`, `DATE`, `OBJECT`, `OPTION`, `CODE`, `CREDENTIAL`. |
| required      | Whether the input is required. Defaults to `false`. Must be `true` for `CREDENTIAL` type.                       |
| description   | **Optional** Description of the input parameter.                                                                |
| default_value | **Optional** Default value for the input.                                                                       |
| data          | **Optional** Type-specific configuration object. See below.                                                     |

The `data` object varies by type:

_Note: The `data` field is only applicable to `OBJECT`, `OPTION` and `CODE` types. Other types do not use this field._

| Type   | data fields                                                               |
| ------ | ------------------------------------------------------------------------- |
| OBJECT | `json_schema`: JSON schema for validation.                                |
| OPTION | `options`: Array of option values. `multi_select_enabled`: Boolean.       |
| CODE   | `code_language`: Language for syntax highlighting (e.g., `HTML`, `JSON`). |

### Sample response

```json
{
  "admin/templates": [
    {
      "id": "472463921472463921",
      "name": "Extract some text",
      "description": "test",
      "agent_type": "Agents::EventTransformationAgent",
      "agent_options": {
        "mode": "extract",
        "matchers": [
          {
            "path": "{{.text}}",
            "regexp": "\\b[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,4}\\b",
            "to": "email_addresses"
          },
          {
            "path": "{{.text}}",
            "regexp": "https?:\\/\\/[\\S]+",
            "to": "urls"
          }
        ],
        "message": "This is an optional message"
      },
      "vendor": "API",
      "product": "API",
      "team_id": 1,
      "folder_id": 42,
      "read_access": "TEAM",
      "shared_team_slugs": [],
      "action_inputs": [
        {
          "name": "input_text",
          "type": "TEXT",
          "description": "The text to extract from",
          "required": true,
          "default_value": "Sample text"
        },
        {
          "name": "output_format",
          "type": "OPTION",
          "description": "Output format selection",
          "required": false,
          "data": {
            "options": ["JSON", "CSV", "Plain Text"],
            "multi_select_enabled": false
          }
        }
      ]
    }
  ],
  "meta": {
    "current_page": "https://<tenant-domain>/api/v1/admin/templates?page=1&per_page=20",
    "previous_page": null,
    "next_page": null,
    "next_page_number": null,
    "per_page": 20,
    "pages": 1,
    "count": 1
  }
}
```