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

# smsTemplates

> List SMS templates, optionally filtered by name or trigger.

**Required scopes:** [`marketing_templates_read`](/docs/api-reference/v3/reference/scopes#scope-marketing_templates_read)

## Arguments

<ResponseField name="after" type="String">
  Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
</ResponseField>

<ResponseField name="before" type="String">
  Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
</ResponseField>

<ResponseField name="first" type="Int">
  Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
</ResponseField>

<ResponseField name="last" type="Int">
  Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
</ResponseField>

<ResponseField name="orderBy" type={<a href="/docs/api-reference/v3/reference/marketing/sms-template-sort-key">SmsTemplateSortKey</a>}>
  Which key to sort by (defaults to the first key, newest-first). Combine with `reverse` to flip direction.
</ResponseField>

<ResponseField name="query" type="String">
  Case-insensitive substring match on the template name. At most 200 characters.
</ResponseField>

<ResponseField name="reverse" type="Boolean">
  Reverses the sort direction selected by `orderBy` (or its default).
</ResponseField>

<ResponseField name="trigger" type={<a href="/docs/api-reference/v3/reference/marketing/marketing-trigger">MarketingTrigger</a>}>
  Only include templates for this trigger.
</ResponseField>

## Returns

<ResponseField name="smsTemplates" type={<a href="/docs/api-reference/v3/pagination">SmsTemplateConnection!</a>} required>
  A paginated list of SmsTemplate items.

  <Expandable title="fields" lazyRender>
    <ResponseField name="edges" type={<a href="/docs/api-reference/v3/pagination">[SmsTemplateEdge!]!</a>} required>
      The list of edges (each a node plus its pagination `cursor`).

      <Expandable title="fields" lazyRender>
        <ResponseField name="cursor" type="String!" required>
          Opaque cursor for this item; pass to `after`/`before` to page from here.
        </ResponseField>

        <ResponseField name="node" type={<a href="/docs/api-reference/v3/reference/marketing/sms-template">SmsTemplate!</a>} required>
          The item at this edge.

          <Expandable title="fields" lazyRender>
            <ResponseField name="autoShortenLinks" type="Boolean!" required>
              Whether links in the body are shortened at send time.
            </ResponseField>

            <ResponseField name="content" type="String!" required>
              The SMS body **as authored**, before per-recipient substitution.
            </ResponseField>

            <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
              When the template was created.
            </ResponseField>

            <ResponseField name="id" type="ID!" required>
              The id of this template.
            </ResponseField>

            <ResponseField name="images" type={<a href="/docs/api-reference/v3/reference/marketing/sms-template-image">[SmsTemplateImage!]!</a>} required>
              Images sent with the message as MMS, in order. Dynamic product images and contact cards set in the editor are not listed.
            </ResponseField>

            <ResponseField name="legacyId" type="String!" required>
              The template's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
            </ResponseField>

            <ResponseField name="name" type="String!" required>
              The merchant-facing name of the template.
            </ResponseField>

            <ResponseField name="trigger" type={<a href="/docs/api-reference/v3/reference/marketing/marketing-trigger">MarketingTrigger!</a>} required>
              The trigger context this template is valid for. Immutable after create. UNKNOWN when the stored trigger is not modeled in this API version.
            </ResponseField>

            <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
              When the template was last edited.
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="nodes" type={<a href="/docs/api-reference/v3/reference/marketing/sms-template">[SmsTemplate!]!</a>} required>
      The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.

      <Expandable title="fields" lazyRender>
        <ResponseField name="autoShortenLinks" type="Boolean!" required>
          Whether links in the body are shortened at send time.
        </ResponseField>

        <ResponseField name="content" type="String!" required>
          The SMS body **as authored**, before per-recipient substitution.
        </ResponseField>

        <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the template was created.
        </ResponseField>

        <ResponseField name="id" type="ID!" required>
          The id of this template.
        </ResponseField>

        <ResponseField name="images" type={<a href="/docs/api-reference/v3/reference/marketing/sms-template-image">[SmsTemplateImage!]!</a>} required>
          Images sent with the message as MMS, in order. Dynamic product images and contact cards set in the editor are not listed.

          <Expandable title="fields" lazyRender>
            <ResponseField name="url" type="String!" required>
              The image URL.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="legacyId" type="String!" required>
          The template's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
        </ResponseField>

        <ResponseField name="name" type="String!" required>
          The merchant-facing name of the template.
        </ResponseField>

        <ResponseField name="trigger" type={<a href="/docs/api-reference/v3/reference/marketing/marketing-trigger">MarketingTrigger!</a>} required>
          The trigger context this template is valid for. Immutable after create. UNKNOWN when the stored trigger is not modeled in this API version.
        </ResponseField>

        <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the template was last edited.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="pageInfo" type={<a href="/docs/api-reference/v3/pagination">PageInfo!</a>} required>
      Pagination metadata for the current page.

      <Expandable title="fields" lazyRender>
        <ResponseField name="endCursor" type="String">
          Cursor of the last edge in this page; pass to `after` to page forward.
        </ResponseField>

        <ResponseField name="hasNextPage" type="Boolean!" required>
          Whether more items exist after this page (drives forward pagination with `first`/`after`).
        </ResponseField>

        <ResponseField name="hasPreviousPage" type="Boolean!" required>
          Whether more items exist before this page (drives backward pagination with `last`/`before`).
        </ResponseField>

        <ResponseField name="startCursor" type="String">
          Cursor of the first edge in this page; pass to `before` to page backward.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

## Example

```graphql theme={null}
query {
  smsTemplates(after: "...", before: "...", first: 10, last: 10, orderBy: CREATED_AT, query: "...", reverse: true, trigger: ADDRESS_VERIFICATION_FAILED) {
    nodes {
      autoShortenLinks
      content
      createdAt
      id
      legacyId
      name
      trigger
      updatedAt
    }
    pageInfo { hasNextPage endCursor }
  }
}
```


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