List SMS brands

List SMS brands

GET/api/v1/sms/brands

GET /sms/brands
curl -X GET 'https://www.unitpost.com/api/v1/sms/brands' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "sms_brand",
      "id": "id_123",
      "name": "Example",
      "legal_name": "string",
      "website": "string",
      "domain": "string",
      "contact_email": "string",
      "status": "incomplete",
      "missing": [
        "string"
      ],
      "ten_dlc_verified": false,
      "tax_id_on_file": false,
      "number_count": 1,
      "editable": false,
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

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.

Parameters3 fields
FieldTypeDescription
limitinteger · queryMax rows to return (default 20, max 100).
afterstring · queryReturn rows after this id (forward paging).
beforestring · queryReturn rows before this id (backward paging).
Response · 200 fields14 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstringPrefixed brand id, e.g. `sbrand_…`.
namerequiredstringPublic-facing brand name.
legal_namerequiredstringRegistered legal entity name.
websiterequiredobjectBrand website URL.
domainrequiredobjectRegistrable domain derived from the website. The brand contact email must be on this domain.
contact_emailrequiredobject—
statusrequiredenumincomplete | ready | pending | action_required | verified | rejected | archived`incomplete` and `action_required` need the customer to act in the dashboard; `pending` is waiting on the carrier.
missingrequiredstring[]Human-readable list of what is still required before this brand can back a number. Empty when nothing is missing.
ten_dlc_verifiedrequiredbooleanTrue when the 10DLC brand registration is approved.
tax_id_on_filerequiredboolean—
number_countrequiredintegerActive (non-released) phone numbers backed by this brand.
editablerequiredbooleanFalse once the brand is locked (carrier-approved or in review). Locked brands can only be corrected when the carrier asks.
created_atrequiredstring—
200401403404422

Search docs and guides

Search the docs and product guides.