List a number's join keywords

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

GET /sms/numbers/{id}/join-keywords

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'

Response · 200

{
  "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"
}

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.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields7 fields

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

200401403404422

List a number's join keywords

List a number's join keywords

Search docs and guides