> ## 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.

# smsKeywords

> List the store's SMS subscribe keywords, optionally only active or only paused ones.

**Required scopes:** [`campaigns_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-campaigns_read)

**Store must have one of:** `EMAIL_SMS`

## Arguments

**after** `String`

Forward pagination cursor — returns keywords after it.

**before** `String`

Backward pagination cursor — returns keywords before it.

**first** `Int`

Forward pagination: returns the first N keywords (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N keywords (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**orderBy** `[SmsKeywordSortKey](/docs/api-reference/v3/reference/marketing/sms-keyword-sort-key)`

Which key to sort by (defaults to the keyword, A–Z). Combine with `reverse` to flip direction.

**reverse** `Boolean`

Reverses the sort direction selected by `orderBy` (or its default).

**status** `[SmsKeywordStatus](/docs/api-reference/v3/reference/marketing/sms-keyword-status)`

Only include keywords with this status.

## Returns

**smsKeywords** `[SmsKeywordConnection!](/docs/api-reference/v3/pagination)` *required*

A paginated list of SmsKeyword items.

**fields**

**edges** `[\[SmsKeywordEdge!\]!](/docs/api-reference/v3/pagination)` *required*

The list of edges (each a node plus its pagination `cursor`).

**fields**

**cursor** `String!` *required*

Opaque cursor for this item; pass to `after`/`before` to page from here.

**node** `[SmsKeyword!](/docs/api-reference/v3/reference/marketing/sms-keyword)` *required*

The item at this edge.

**fields**

**createdAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the keyword was created.

**id** `ID!` *required*

The id of this keyword.

**keyword** `String!` *required*

The text a customer sends to subscribe: 3 to 20 uppercase letters or digits. Matching ignores case.

**status** `[SmsKeywordStatus!](/docs/api-reference/v3/reference/marketing/sms-keyword-status)` *required*

Whether texting this keyword subscribes the sender.

**tags** `[\[CustomerTag!\]!](/docs/api-reference/v3/reference/marketing/customer-tag)` *required*

Customer tags added to each customer who subscribes with this keyword, A–Z by name. A tag deleted from the catalog is left out.

**Requires:** [`customers_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-customers_read)

**updatedAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the keyword was last changed.

**nodes** `[\[SmsKeyword!\]!](/docs/api-reference/v3/reference/marketing/sms-keyword)` *required*

The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.

**fields**

**createdAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the keyword was created.

**id** `ID!` *required*

The id of this keyword.

**keyword** `String!` *required*

The text a customer sends to subscribe: 3 to 20 uppercase letters or digits. Matching ignores case.

**status** `[SmsKeywordStatus!](/docs/api-reference/v3/reference/marketing/sms-keyword-status)` *required*

Whether texting this keyword subscribes the sender.

**tags** `[\[CustomerTag!\]!](/docs/api-reference/v3/reference/marketing/customer-tag)` *required*

Customer tags added to each customer who subscribes with this keyword, A–Z by name. A tag deleted from the catalog is left out.

**Requires:** [`customers_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-customers_read)

**fields**

**id** `ID!` *required*

The id of this customer tag.

**legacyId** `String!` *required*

The tag's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.

**name** `String!` *required*

The merchant-facing name of the tag.

**provider** `[CustomerTagProvider](/docs/api-reference/v3/reference/marketing/customer-tag-provider)`

Who has authority to add or remove this tag. Null on older records that predate provider.

**source** `[CustomerTagSource!](/docs/api-reference/v3/reference/marketing/customer-tag-source)` *required*

Where this tag was created.

**updatedAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the keyword was last changed.

**pageInfo** `[PageInfo!](/docs/api-reference/v3/pagination)` *required*

Pagination metadata for the current page.

**fields**

**endCursor** `String`

Cursor of the last edge in this page; pass to `after` to page forward.

**hasNextPage** `Boolean!` *required*

Whether more items exist after this page (drives forward pagination with `first`/`after`).

**hasPreviousPage** `Boolean!` *required*

Whether more items exist before this page (drives backward pagination with `last`/`before`).

**startCursor** `String`

Cursor of the first edge in this page; pass to `before` to page backward.

## Example

```graphql theme={null}
query {
  smsKeywords(after: "...", before: "...", first: 10, last: 10, orderBy: KEYWORD, reverse: true, status: ACTIVE) {
    nodes {
      createdAt
      id
      keyword
      status
      updatedAt
    }
    pageInfo { hasNextPage endCursor }
  }
}
```


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