List carrier registrations

List carrier registrations

GET/api/v1/sms/registrations

GET /sms/registrations
curl -X GET 'https://www.unitpost.com/api/v1/sms/registrations' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "sms_registration",
      "id": "id_123",
      "type": "string",
      "brand_id": "brand_123",
      "status": "queued",
      "requires_action": false,
      "feedback": [
        {}
      ],
      "use_case": "string",
      "message_type": "string",
      "parent_registration_id": "parent_registration_123",
      "auto_provision_number": false,
      "sender": {
        "id": "id_123",
        "status": "queued",
        "phone_number": "string"
      },
      "setup_state": "string",
      "number_withheld_reason": "string",
      "archived_at": "2026-01-01T00:00:00.000Z",
      "submitted_at": "2026-01-01T00:00:00.000Z",
      "completed_at": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Your carrier registrations (10DLC brand and campaign, toll-free) with their review state and the carrier's feedback; a 10DLC campaign also carries the number it backs and one setup state. Submitting or resubmitting a 10DLC one is an SMS quote, then its confirm; toll-free verification and removing one happen 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 fields18 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
typerequiredstring`us_ten_dlc_brand`, `us_ten_dlc_campaign`, or a toll-free verification.
brand_idrequiredstring | null—
statusrequiredstringThe carrier review state: `draft`, `submitted`, `reviewing`, `requires_updates`, `complete`, `closed`, …
requires_actionrequiredbooleanThe customer must act (the carrier asked for changes).
feedbackrequiredobject[] | nullThe carrier's reasons when it asks for changes or closes it (`reason`, `description`, `field_path`, `link`).
use_caserequiredstring | null—
message_typerequiredstring | null—
parent_registration_idrequiredstring | null—
auto_provision_numberrequiredboolean | null10DLC campaigns: a number is leased when carriers approve.
senderrequiredobject | null10DLC campaigns: the number it backs, once one exists.
setup_staterequiredstring | null10DLC campaigns: one customer-facing state over the campaign and its number.
number_withheld_reasonrequiredstring | nullWhy an approved campaign's number isn't being leased (e.g. the plan has no carrier resources).
archived_atrequiredstring | null—
submitted_atrequiredstring | null—
completed_atrequiredstring | null—
created_atrequiredstring—
200401403404422

Search docs and guides

Search the docs and product guides.