---
title: "Retrieve a keyword"
method: GET
path: "/keywords/{keyword_id}"
tags: ["keywords"]
---

# Retrieve a keyword

`GET /keywords/{keyword_id}`

## Request

- Base URL: `https://api.pscrpt.com/v1`
- URL: `https://api.pscrpt.com/v1/keywords/{keyword_id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://api.pscrpt.com/oauth/authorize`
    - Token URL: `https://api.pscrpt.com/oauth/token` scopes: `keywords:read`

Retrieves a merchant keyword, including a disabled keyword.

## Headers

- `Postscript-Version` string, date

## Response `200`

The keyword.

- KeywordEnvelope
  - `data` Keyword, required
    - `action` 'opt_in' | 'opt_out' | 'info', required
    - `created_at` string, date-time, required
    - `enabled` boolean, required
    - `fuzzy_match` boolean, required
    - `id` string, required
    - `keyword` string, required: Uppercase keyword text.
    - `object` 'keyword', required
    - `tags` string[], required: Tags applied to subscribers who opt in through this keyword.
    - `triggered_count` integer, required: Approximate number of inbound keyword matches.
    - `updated_at` string, date-time, required
  - `meta` Meta, required
    - `as_of` string, date-time
    - `livemode` boolean, required
    - `page` PageMeta
      - `limit` integer, required
      - `next_cursor` string, nullable, required: Pass as `page[after]`. Null on the last page.
    - `request_id` string, required
    - `resolved_from` string: The merged-away profile ID the request addressed; `data` holds the survivor.
    - `revision` string, date, required

## Other responses

- `400`: Malformed input, an unknown parameter, an unsupported filter, sort, or expand, or a mistyped ID.
- `401`: Missing or invalid API key.
- `403`: The key lacks the required scope.
- `404`: No such resource in the authenticated property.
- `429`: Rate limit exceeded.
- `500`: Internal error.
- `502`: Upstream provider failure.
- `503`: Keyword reads are temporarily unavailable or at capacity; retry after the indicated delay.

## Changes

- **2026-10-09** `8dfa57319d25`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pscrpt/apis/postscript-native-api-beta/changes/keywords/:keyword_id/get.md)

---

[API](https://skmtc.dev/pscrpt/apis/postscript-native-api-beta.md) - [All operations](https://skmtc.dev/pscrpt/apis/postscript-native-api-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/pscrpt/apis/postscript-native-api-beta/revisions/882458ee1f36?raw)