Retrieve an SMS topic

Retrieve an SMS topic

GET/api/v1/sms/topics/{id}

GET /sms/topics/{id}
curl -X GET 'https://www.unitpost.com/api/v1/sms/topics/top_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "topic",
  "id": "id_123",
  "name": "Example",
  "description": "string",
  "channel": "email",
  "default_opt_in": false,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Retrieve a single SMS topic by id. An email topic id returns 404 here. Change it with Update an SMS topic. Requires the topics:read capability.

Parameters1 field
FieldTypeDescription
idrequiredstring · path—
Response · 200 fields8 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
namerequiredstring—
descriptionrequiredstring | null—
channelrequiredenumemail | smsWhich channel the topic belongs to. Email topics are managed under `/email/topics`, SMS topics under `/sms/topics`.
default_opt_inrequiredboolean—
created_atrequiredstring—
updated_atrequiredstring—
200401403404

Search docs and guides

Search the docs and product guides.