---
title: "Retrieve a messaging program"
description: "Retrieve one program, archived ones too. `GET /api/v1/sms/messaging-programs/{id}`"
url: https://www.unitpost.com/docs/sms/get-sms-messaging-programs-id
section: "SMS API reference"
updated: 2026-10-13
---
# Retrieve a messaging program

`GET /api/v1/sms/messaging-programs/{id}`

Retrieve one program, archived ones too. Requires the `sms:read` capability.

## Parameters

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

## Response fields (200)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | yes | — |
| `description` | string \| null | no | — |
| `message_type` | enum | yes | One of: `transactional`, `marketing`. |
| `canonical_purpose` | string \| null | no | — |
| `frequency_disclosure` | string \| null | no | — |
| `opt_in_type` | string \| null | no | — |
| `opt_in_workflow` | string \| null | no | — |
| `opt_in_confirmation` | string \| null | no | — |
| `help_message` | string \| null | no | — |
| `stop_message` | string \| null | no | — |
| `terms_url` | string \| null | no | — |
| `privacy_url` | string \| null | no | — |
| `monthly_volume` | string \| null | no | — |
| `sample_messages` | string[] | yes | — |
| `embedded_links` | boolean | yes | — |
| `embedded_link_sample` | string \| null | no | — |
| `embedded_phones` | boolean | yes | — |
| `age_gated` | boolean | yes | — |
| `provider_overrides` | object \| null | no | — |
| `recipe_id` | string \| null | yes | — |
| `consent_setup_id` | string \| null | no | A consent setup (`cset_…`) this workspace has. |
| `object` | string | yes | — |
| `id` | string | yes | — |
| `recipe_version` | integer \| null | yes | — |
| `revision` | integer | yes | Moves on a material change; registrations keep the revision they copied. |
| `readiness` | object | yes | Whether the program has what a registration needs; `missing` names the fields still to fill (the wizard's own check). |
| `archived_at` | string \| null | yes | — |
| `created_at` | string | yes | — |
| `updated_at` | string | yes | — |

## Responses

| Status | Description |
| --- | --- |
| 200 | The program. |
| 401 | Missing or invalid API key. |
| 403 | Insufficient scope. |
| 404 | Messaging program not found, or SMS is not enabled. |
| 422 | A query key (this operation takes none). |

## Example request

```bash
curl -X GET 'https://www.unitpost.com/api/v1/sms/messaging-programs/123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
```

## Example response (200)

```json
{
  "name": "Example",
  "description": "string",
  "message_type": "transactional",
  "canonical_purpose": "string",
  "frequency_disclosure": "string",
  "opt_in_type": "string",
  "opt_in_workflow": "string",
  "opt_in_confirmation": "string",
  "help_message": "string",
  "stop_message": "string",
  "terms_url": "https://example.com",
  "privacy_url": "https://example.com",
  "monthly_volume": "string",
  "sample_messages": [
    "string"
  ],
  "embedded_links": false,
  "embedded_link_sample": "string",
  "embedded_phones": false,
  "age_gated": false,
  "provider_overrides": {
    "toll_free": {
      "use_case_category": "string"
    },
    "ten_dlc": {
      "use_case": "string",
      "sub_use_cases": [
        "string"
      ]
    }
  },
  "recipe_id": "recipe_123",
  "consent_setup_id": "consent_setup_123",
  "object": "sms_messaging_program",
  "id": "id_123",
  "recipe_version": 0,
  "revision": 0,
  "readiness": {
    "ready": false,
    "missing": [
      "string"
    ]
  },
  "archived_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}
```

## 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-messaging-programs-id
- OpenAPI 3.1 (full schemas): https://www.unitpost.com/api/v1/openapi.json