---
title: "List a number's join keywords"
description: "Text-to-join: the words people can text this number to sign up. `GET /api/v1/sms/numbers/{id}/join-keywords`"
url: https://www.unitpost.com/docs/sms/get-sms-numbers-id-join-keywords
section: "SMS API reference"
updated: 2026-11-11
---
# List a number's join keywords

`GET /api/v1/sms/numbers/{id}/join-keywords`

Text-to-join: the words people can text this number to sign up. `registration_warning` is set when the number's carrier registration doesn't list keyword opt-in, so carriers could flag the sign-ups. Requires the `sms:read` capability.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes | — |

## Response fields (200)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | — |
| `id` | string | yes | `sjk_…`. |
| `number_id` | string | yes | The number (`snum_…`) people text the keyword to. |
| `keyword` | string | yes | As you wrote it. A text matches it whatever the case and surrounding punctuation. |
| `segment_id` | string \| null | yes | The static segment (`seg_…`) a confirmed texter joins, or null. |
| `topic_id` | string \| null | yes | The SMS topic a confirmed texter is subscribed to, or null. |
| `created_at` | string | yes | — |

## Responses

| Status | Description |
| --- | --- |
| 200 | The keywords. |
| 401 | Missing or invalid API key. |
| 403 | Insufficient scope. |
| 404 | Number not found, or SMS is not enabled. |
| 422 | An unknown query key. |

## Example request

```bash
curl -X GET 'https://www.unitpost.com/api/v1/sms/numbers/sms_123/join-keywords' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
```

## Example response (200)

```json
{
  "object": "list",
  "data": [
    {
      "object": "sms_join_keyword",
      "id": "id_123",
      "number_id": "number_123",
      "keyword": "string",
      "segment_id": "segment_123",
      "topic_id": "topic_123",
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "has_more": false,
  "registration_warning": "string"
}
```

## Links

- HTML reference (with Node.js, Python, Ruby, PHP, Laravel, Go, Java, Rust, .NET and CLI examples): https://www.unitpost.com/docs/sms/get-sms-numbers-id-join-keywords
- OpenAPI 3.1 (full schemas): https://www.unitpost.com/api/v1/openapi.json