> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Lemlist: Get Snippets

> List Snippets. Lemlist Get Snippets reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

List Snippets.

<Info>
  Tool ID: `lemlist_get_snippets`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'lemlist_get_snippets',
  {
    "search": "software companies hiring engineers",
    "userIds": "user_123",
    "page": 1
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute lemlist_get_snippets --input '{
  "search": "software companies hiring engineers",
  "userIds": "user_123",
  "page": 1
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "data": [
      {
        "_id": "_123",
        "name": "Example",
        "content": "Example message"
      }
    ],
    "meta": {
      "pagination": {
        "page": 123,
        "limit": 123,
        "totalRecords": 123
      }
    }
  }
}
```

Use `deepline tools get lemlist_get_snippets --json` for the latest machine-readable contract.

## Input reference

Lists the team's snippets (the fragments of the Templates page > Snippets), by name, with a name search and a creator filter.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.search` | `string` | No | — | Substring of the name, case-insensitive. Accented a, c, e, i, n, o, u, y match their plain letters (`relance` finds `Rélance`). Names only: bodies and subjects are not searched. Maximum 100 characters; a blank value is no filter. Maximum length: 100. |
| `payload.userIds` | `string` | No | — | Keep the items created by any of these users (`usr_` ids, see GET /team/members). Comma-separated; the parameter may also be repeated. Maximum 100. Omit for every creator. |
| `payload.page` | `integer` | No | `1` | Page number to retrieve, starting at 1 Minimum: 1. |
| `payload.limit` | `integer` | No | `50` | Number of items per page. Maximum value: 100 Minimum: 1. Maximum: 100. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Lists the team's snippets (the fragments of the Templates page > Snippets), by name, with a name search and a creator filter.",
    "properties": {
      "search": {
        "type": "string",
        "description": "Substring of the name, case-insensitive. Accented a, c, e, i, n, o, u, y match their plain letters (`relance` finds `Rélance`). Names only: bodies and subjects are not searched. Maximum 100 characters; a blank value is no filter.",
        "maxLength": 100
      },
      "userIds": {
        "type": "string",
        "description": "Keep the items created by any of these users (`usr_` ids, see GET /team/members). Comma-separated; the parameter may also be repeated. Maximum 100. Omit for every creator."
      },
      "page": {
        "type": "integer",
        "description": "Page number to retrieve, starting at 1",
        "default": 1,
        "minimum": 1
      },
      "limit": {
        "type": "integer",
        "description": "Number of items per page. Maximum value: 100",
        "default": 50,
        "minimum": 1,
        "maximum": 100
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `array` | No | — | — |
| `result.data.data[]._id` | `string` | No | — | Snippet identifier (`snt_`) |
| `result.data.data[].name` | `string` | No | — | Name shown on the Templates page |
| `result.data.data[].content` | `string` | No | — | HTML content as authored, variables left as `&#123;&#123;variable&#125;&#125;` |
| `result.data.data[].createdBy` | `string` | No | — | Creator user id (`usr_`), see GET /team/members |
| `result.data.data[].createdAt` | `string` | No | — | Creation date Format: `date-time`. |
| `result.data.meta` | `object` | No | — | Pagination block of a list response. `totalPages` is at least 1: an empty result is page 1 of 1. |
| `result.data.meta.pagination` | `object` | No | — | — |
| `result.data.meta.pagination.page` | `integer` | No | — | Current page number |
| `result.data.meta.pagination.limit` | `integer` | No | — | Number of records per page |
| `result.data.meta.pagination.totalRecords` | `integer` | No | — | Total records matching the filters |
| `result.data.meta.pagination.totalPages` | `integer` | No | — | Total number of pages, at least 1 |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "A snippet: an HTML fragment (a signature, a paragraph, a call-to-action) inserted inside a message. The content is HTML as authored: sanitize it before rendering.",
              "properties": {
                "_id": {
                  "type": "string",
                  "description": "Snippet identifier (`snt_`)"
                },
                "name": {
                  "type": "string",
                  "description": "Name shown on the Templates page"
                },
                "content": {
                  "type": "string",
                  "description": "HTML content as authored, variables left as `{{variable}}`"
                },
                "createdBy": {
                  "type": "string",
                  "description": "Creator user id (`usr_`), see GET /team/members"
                },
                "createdAt": {
                  "type": "string",
                  "description": "Creation date",
                  "format": "date-time"
                }
              },
              "additionalProperties": false
            }
          },
          "meta": {
            "type": "object",
            "description": "Pagination block of a list response. `totalPages` is at least 1: an empty result is page 1 of 1.",
            "properties": {
              "pagination": {
                "type": "object",
                "properties": {
                  "page": {
                    "type": "integer",
                    "description": "Current page number"
                  },
                  "limit": {
                    "type": "integer",
                    "description": "Number of records per page"
                  },
                  "totalRecords": {
                    "type": "integer",
                    "description": "Total records matching the filters"
                  },
                  "totalPages": {
                    "type": "integer",
                    "description": "Total number of pages, at least 1"
                  }
                },
                "additionalProperties": false
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Lemlist provider guide](/docs/providers/lemlist/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.