---
title: "List SMS brands"
method: GET
path: "/sms/brands"
tags: ["SMS"]
---

# List SMS brands

`GET /sms/brands`

## Request

- Base URL: `https://www.unitpost.com/api/v1`
- URL: `https://www.unitpost.com/api/v1/sms/brands`
- Auth: HTTP bearer

Retrieve your SMS brands and their setup status. A brand is the business identity carriers register before they will approve a phone number, so this is the endpoint to poll when you need to know whether SMS is usable yet: `status` reports whether you or the carrier is the blocker, and `missing` lists exactly what is still required. Creating or editing a brand is a paid carrier submission and is only available in the dashboard. Requires the `sms:read` capability.

## Query parameters

- `limit` integer
- `after` string
- `before` string

## Response `200`

A page of SMS brands.

- object
  - `object` 'list', required
  - `has_more` boolean, required
  - `data` SmsBrand[], required
    - `object` 'sms_brand', required
    - `id` string, required: Prefixed brand id, e.g. `sbrand_…`.
    - `name` string, required: Public-facing brand name.
    - `legal_name` string, required: Registered legal entity name.
    - `website` string, nullable, required: Brand website URL.
    - `domain` string, nullable, required: Registrable domain derived from the website. The brand contact email must be on this domain.
    - `contact_email` string, nullable, required
    - `status` 'incomplete' | 'ready' | 'pending' | 'action_required' | 'verified' | 'rejected' | 'archived', required: `incomplete` and `action_required` need the customer to act in the dashboard; `pending` is waiting on the carrier.
    - `missing` string[], required: Human-readable list of what is still required before this brand can back a number. Empty when nothing is missing.
    - `ten_dlc_verified` boolean, required: True when the 10DLC brand registration is approved.
    - `tax_id_on_file` boolean, required
    - `number_count` integer, required: Non-released senders on this brand (phone numbers and Sender ID countries, any status).
    - `editable` boolean, required: False once the brand is locked: carriers approved or are reviewing its 10DLC registration, or senders are registered with its details. Locked brands are corrected only when carriers ask.
    - `created_at` string, required

## Other responses

- `401`: Missing or invalid API key.
- `403`: Insufficient scope.
- `404`: SMS is not enabled for this workspace.
- `422`: Invalid pagination params.

---

[API](https://skmtc.dev/unitpost/apis/unitpost-api.md) · [All operations](https://skmtc.dev/unitpost/apis/unitpost-api/llms.txt) · [OpenAPI document](https://skmtc.dev/unitpost/apis/unitpost-api/revisions/86ff7c890967?raw)