> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sendora.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List or read SMS registrations

> Lists the workspace's SMS registrations: the business (brand) and the texting campaigns under it. Filter with type=brand or type=campaign. Pass type and id to read one, and include=events, numbers or eligible_numbers to add its timeline or numbers. view=readiness says whether this workspace can text yet and what the next step is, with the choices the forms accept; add quote=brand, campaign or vetting (with entity_type or use_case) for the exact fee before you submit. Requires a Sendora API key.



## OpenAPI

````yaml /openapi.json get /api/v1/public/sms-registrations
openapi: 3.1.0
info:
  description: >-
    Customer-facing API for managing outreach, leads, conversations, voice
    agents, knowledge bases, analytics, and webhooks.
  title: Sendora Public API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.sendora.ai
security: []
tags:
  - description: Leads, lead lists, importing, enriching and finding new prospects.
    name: Leads
  - description: Build, run and measure outreach, and enroll leads.
    name: Campaigns
  - description: Read and send messages, and manage who must not be contacted.
    name: Conversations
  - description: >-
      Voice and chat agents, their tools, knowledge bases, voices and website
      widgets.
    name: Agents
  - description: >-
      Start calls, and manage phone numbers, SMS registration, sending accounts
      and email domains.
    name: Calls and numbers
  - description: Webhooks, jobs, analytics and the Copilot assistant.
    name: Platform
  - description: Manage client workspaces, plans and branding.
    name: Agency
paths:
  /api/v1/public/sms-registrations:
    get:
      tags:
        - Calls and numbers
      summary: List or read SMS registrations
      description: >-
        Lists the workspace's SMS registrations: the business (brand) and the
        texting campaigns under it. Filter with type=brand or type=campaign.
        Pass type and id to read one, and include=events, numbers or
        eligible_numbers to add its timeline or numbers. view=readiness says
        whether this workspace can text yet and what the next step is, with the
        choices the forms accept; add quote=brand, campaign or vetting (with
        entity_type or use_case) for the exact fee before you submit. Requires a
        Sendora API key.
      operationId: list_sms_registrations_api_v1_public_sms_registrations_get
      parameters:
        - description: brand or campaign; omit for both
          in: query
          name: type
          required: false
          schema:
            anyOf:
              - enum:
                  - brand
                  - campaign
                type: string
              - type: 'null'
            description: brand or campaign; omit for both
            title: Type
        - description: >-
            The registration's id: the `id` from List or read SMS registrations.
            Send the matching `type` with it.
          in: query
          name: id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: One registration id; requires type
            title: Id
        - description: 'Comma list: events, numbers, eligible_numbers (needs id)'
          in: query
          name: include
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: 'Comma list: events, numbers, eligible_numbers (needs id)'
            title: Include
        - description: >-
            readiness: can the workspace text yet, the form options, and an
            optional fee quote
          in: query
          name: view
          required: false
          schema:
            anyOf:
              - const: readiness
                type: string
              - type: 'null'
            description: >-
              readiness: can the workspace text yet, the form options, and an
              optional fee quote
            title: View
        - description: 'With view=readiness: also quote this fee'
          in: query
          name: quote
          required: false
          schema:
            anyOf:
              - enum:
                  - brand
                  - campaign
                  - vetting
                type: string
              - type: 'null'
            description: 'With view=readiness: also quote this fee'
            title: Quote
        - description: 'With quote=brand: the business type'
          in: query
          name: entity_type
          required: false
          schema:
            anyOf:
              - maxLength: 40
                type: string
              - type: 'null'
            description: 'With quote=brand: the business type'
            title: Entity Type
        - description: 'With quote=campaign: the use case'
          in: query
          name: use_case
          required: false
          schema:
            anyOf:
              - maxLength: 60
                type: string
              - type: 'null'
            description: 'With quote=campaign: the use case'
            title: Use Case
        - in: header
          name: X-API-Key
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
        - in: header
          name: Authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/RegistrationList'
                  - type: object
                title: >-
                  Response List Sms Registrations Api V1 Public Sms
                  Registrations Get
          description: Successful Response
        '401':
          description: The X-API-Key header is missing, invalid, expired, or revoked.
        '402':
          description: >-
            The workspace is suspended for billing, or the request would exceed
            a plan or usage limit.
        '403':
          description: >-
            The key is valid but lacks the required scope, or the workspace has
            no active plan, lacks the entitlement, or has this feature turned
            off or view-only.
        '410':
          description: The workspace behind this key has been deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '500':
          description: >-
            An unexpected Sendora error occurred. Retry only if the operation is
            safe to repeat.
        '503':
          description: >-
            An entitlement or billing check is temporarily unavailable. Retry
            after the Retry-After interval.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - label: cURL
          lang: bash
          source: >-
            curl -X GET 'https://api.sendora.ai/api/v1/public/sms-registrations'
            -H "X-API-Key: $SENDORA_API_KEY"
        - label: Python
          lang: python
          source: |-
            import requests

            url = 'https://api.sendora.ai/api/v1/public/sms-registrations'
            headers = {'X-API-Key': '$SENDORA_API_KEY'}
            response = requests.get(url, headers=headers)
            response.raise_for_status()
            print(response.json())
        - label: JavaScript
          lang: javascript
          source: >-
            const response = await
            fetch("https://api.sendora.ai/api/v1/public/sms-registrations", {
              method: "GET",
              headers: { 'X-API-Key': process.env.SENDORA_API_KEY },
            });

            if (!response.ok) throw new Error(await response.text());

            console.log(await response.json());
        - label: Go
          lang: go
          source: >-
            req, err := http.NewRequest("GET",
            "https://api.sendora.ai/api/v1/public/sms-registrations", nil)

            if err != nil { log.Fatal(err) }

            req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))

            resp, err := http.DefaultClient.Do(req)

            if err != nil { log.Fatal(err) }

            defer resp.Body.Close()
components:
  schemas:
    RegistrationList:
      properties:
        items:
          description: Items returned by the Sendora API.
          items:
            discriminator:
              mapping:
                brand: '#/components/schemas/RegistrationBrand'
                campaign: '#/components/schemas/RegistrationCampaign'
              propertyName: type
            oneOf:
              - $ref: '#/components/schemas/RegistrationBrand'
              - $ref: '#/components/schemas/RegistrationCampaign'
          title: Items
          type: array
        total:
          description: Total returned by the Sendora API.
          title: Total
          type: integer
      required:
        - items
        - total
      title: RegistrationList
      type: object
    HTTPValidationError:
      properties:
        detail:
          description: Detail returned by the Sendora API.
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      required: []
      title: HTTPValidationError
      type: object
    RegistrationBrand:
      properties:
        business_contact_email:
          anyOf:
            - type: string
            - type: 'null'
          description: Business contact email returned by the Sendora API.
          title: Business Contact Email
        can_delete:
          description: Can delete returned by the Sendora API.
          title: Can Delete
          type: boolean
        can_edit:
          description: Can edit returned by the Sendora API.
          title: Can Edit
          type: boolean
        can_request_vetting:
          description: Can request vetting returned by the Sendora API.
          title: Can Request Vetting
          type: boolean
        can_revet:
          description: Can revet returned by the Sendora API.
          title: Can Revet
          type: boolean
        city:
          anyOf:
            - type: string
            - type: 'null'
          description: City returned by the Sendora API.
          title: City
        company_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Company name returned by the Sendora API.
          title: Company Name
        country:
          default: US
          description: Country returned by the Sendora API.
          title: Country
          type: string
        created_at:
          description: Created at returned by the Sendora API.
          title: Created At
          type: string
        delete_blocked_reason:
          anyOf:
            - type: string
            - type: 'null'
          description: Delete blocked reason returned by the Sendora API.
          title: Delete Blocked Reason
        display_name:
          description: Display name returned by the Sendora API.
          title: Display Name
          type: string
        ein_last4:
          anyOf:
            - type: string
            - type: 'null'
          description: Ein last4 returned by the Sendora API.
          title: Ein Last4
        email:
          anyOf:
            - type: string
            - type: 'null'
          description: Email returned by the Sendora API.
          title: Email
        entity_type:
          description: Entity type returned by the Sendora API.
          title: Entity Type
          type: string
        events:
          anyOf:
            - items:
                type: object
              type: array
            - type: 'null'
          description: Timeline, when include=events
          title: Events
        first_name:
          anyOf:
            - type: string
            - type: 'null'
          description: First name returned by the Sendora API.
          title: First Name
        issues:
          default: []
          description: Issues returned by the Sendora API.
          items:
            $ref: '#/components/schemas/IssueOut'
          title: Issues
          type: array
        last_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Last name returned by the Sendora API.
          title: Last Name
        mobile_phone:
          anyOf:
            - type: string
            - type: 'null'
          description: Mobile phone returned by the Sendora API.
          title: Mobile Phone
        phone:
          anyOf:
            - type: string
            - type: 'null'
          description: Phone returned by the Sendora API.
          title: Phone
        postal_code:
          anyOf:
            - type: string
            - type: 'null'
          description: Postal code returned by the Sendora API.
          title: Postal Code
        public_id:
          description: >-
            The registration's id. Pass it as `id` to edit, delete or run an
            action on it.
          title: Public Id
          type: string
        state:
          description: State returned by the Sendora API.
          title: State
          type: string
        state_code:
          anyOf:
            - type: string
            - type: 'null'
          description: State code returned by the Sendora API.
          title: State Code
        status_text:
          default: ''
          description: Status text returned by the Sendora API.
          title: Status Text
          type: string
        stock_exchange:
          anyOf:
            - type: string
            - type: 'null'
          description: Stock exchange returned by the Sendora API.
          title: Stock Exchange
        stock_symbol:
          anyOf:
            - type: string
            - type: 'null'
          description: Stock symbol returned by the Sendora API.
          title: Stock Symbol
        street:
          anyOf:
            - type: string
            - type: 'null'
          description: Street returned by the Sendora API.
          title: Street
        trust:
          description: Trust returned by the Sendora API.
          title: Trust
          type: string
        type:
          const: brand
          default: brand
          description: Type returned by the Sendora API.
          title: Type
          type: string
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          description: Updated at returned by the Sendora API.
          title: Updated At
        vertical:
          anyOf:
            - type: string
            - type: 'null'
          description: Vertical returned by the Sendora API.
          title: Vertical
        website:
          anyOf:
            - type: string
            - type: 'null'
          description: Website returned by the Sendora API.
          title: Website
      required:
        - public_id
        - state
        - trust
        - entity_type
        - display_name
        - can_edit
        - can_delete
        - can_request_vetting
        - can_revet
        - created_at
      title: RegistrationBrand
      type: object
    RegistrationCampaign:
      properties:
        age_gated:
          default: false
          description: Age gated returned by the Sendora API.
          title: Age Gated
          type: boolean
        auto_renew:
          default: true
          description: Auto renew returned by the Sendora API.
          title: Auto Renew
          type: boolean
        brand_display_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Brand display name returned by the Sendora API.
          title: Brand Display Name
        brand_public_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The business (brand) this campaign belongs to: the `id` of a brand
            from List or read SMS registrations.
          title: Brand Public Id
        can_appeal:
          description: Can appeal returned by the Sendora API.
          title: Can Appeal
          type: boolean
        can_clone:
          description: Can clone returned by the Sendora API.
          title: Can Clone
          type: boolean
        can_delete:
          description: Can delete returned by the Sendora API.
          title: Can Delete
          type: boolean
        can_edit_samples:
          description: Can edit samples returned by the Sendora API.
          title: Can Edit Samples
          type: boolean
        carriers:
          default: []
          description: Carriers returned by the Sendora API.
          items:
            $ref: '#/components/schemas/CarrierOut'
          title: Carriers
          type: array
        created_at:
          description: Created at returned by the Sendora API.
          title: Created At
          type: string
        delete_blocked_reason:
          anyOf:
            - type: string
            - type: 'null'
          description: Delete blocked reason returned by the Sendora API.
          title: Delete Blocked Reason
        description:
          anyOf:
            - type: string
            - type: 'null'
          description: Description returned by the Sendora API.
          title: Description
        direct_lending:
          default: false
          description: Direct lending returned by the Sendora API.
          title: Direct Lending
          type: boolean
        eligible_numbers:
          anyOf:
            - items:
                type: object
              type: array
            - type: 'null'
          description: Numbers that can be attached, when include=eligible_numbers
          title: Eligible Numbers
        embedded_link:
          default: false
          description: Embedded link returned by the Sendora API.
          title: Embedded Link
          type: boolean
        embedded_link_sample:
          anyOf:
            - type: string
            - type: 'null'
          description: Embedded link sample returned by the Sendora API.
          title: Embedded Link Sample
        embedded_phone:
          default: false
          description: Embedded phone returned by the Sendora API.
          title: Embedded Phone
          type: boolean
        events:
          anyOf:
            - items:
                type: object
              type: array
            - type: 'null'
          description: Timeline, when include=events
          title: Events
        help_keywords:
          anyOf:
            - type: string
            - type: 'null'
          description: Help keywords returned by the Sendora API.
          title: Help Keywords
        help_message:
          anyOf:
            - type: string
            - type: 'null'
          description: Help message returned by the Sendora API.
          title: Help Message
        issues:
          default: []
          description: Issues returned by the Sendora API.
          items:
            $ref: '#/components/schemas/IssueOut'
          title: Issues
          type: array
        message_flow:
          anyOf:
            - type: string
            - type: 'null'
          description: Message flow returned by the Sendora API.
          title: Message Flow
        monthly_cents:
          anyOf:
            - type: integer
            - type: 'null'
          description: Monthly cents returned by the Sendora API.
          title: Monthly Cents
        next_renewal_at:
          anyOf:
            - type: string
            - type: 'null'
          description: Next renewal at returned by the Sendora API.
          title: Next Renewal At
        number_limit:
          default: 49
          description: Number limit returned by the Sendora API.
          title: Number Limit
          type: integer
        number_pool:
          default: false
          description: Number pool returned by the Sendora API.
          title: Number Pool
          type: boolean
        numbers:
          anyOf:
            - $ref: '#/components/schemas/CampaignNumbersOut'
            - type: 'null'
          description: Attached numbers, when include=numbers or after a number action
        numbers_count:
          default: 0
          description: Numbers count returned by the Sendora API.
          title: Numbers Count
          type: integer
        numbers_remaining:
          default: 49
          description: Numbers remaining returned by the Sendora API.
          title: Numbers Remaining
          type: integer
        opt_in_method:
          anyOf:
            - type: string
            - type: 'null'
          description: Opt in method returned by the Sendora API.
          title: Opt In Method
        optin_keywords:
          anyOf:
            - type: string
            - type: 'null'
          description: Optin keywords returned by the Sendora API.
          title: Optin Keywords
        optin_message:
          anyOf:
            - type: string
            - type: 'null'
          description: Optin message returned by the Sendora API.
          title: Optin Message
        optout_keywords:
          anyOf:
            - type: string
            - type: 'null'
          description: Optout keywords returned by the Sendora API.
          title: Optout Keywords
        optout_message:
          anyOf:
            - type: string
            - type: 'null'
          description: Optout message returned by the Sendora API.
          title: Optout Message
        privacy_link:
          anyOf:
            - type: string
            - type: 'null'
          description: Privacy link returned by the Sendora API.
          title: Privacy Link
        public_id:
          description: >-
            The registration's id. Pass it as `id` to edit, delete or run an
            action on it.
          title: Public Id
          type: string
        samples:
          default: []
          description: Samples returned by the Sendora API.
          items:
            type: string
          title: Samples
          type: array
        state:
          description: State returned by the Sendora API.
          title: State
          type: string
        status_text:
          default: ''
          description: Status text returned by the Sendora API.
          title: Status Text
          type: string
        sub_use_cases:
          default: []
          description: Sub use cases returned by the Sendora API.
          items:
            type: string
          title: Sub Use Cases
          type: array
        terms_link:
          anyOf:
            - type: string
            - type: 'null'
          description: Terms link returned by the Sendora API.
          title: Terms Link
        type:
          const: campaign
          default: campaign
          description: Type returned by the Sendora API.
          title: Type
          type: string
        up_front_cents:
          anyOf:
            - type: integer
            - type: 'null'
          description: Up front cents returned by the Sendora API.
          title: Up Front Cents
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          description: Updated at returned by the Sendora API.
          title: Updated At
        use_case:
          description: Use case returned by the Sendora API.
          title: Use Case
          type: string
        use_case_label:
          description: Use case label returned by the Sendora API.
          title: Use Case Label
          type: string
      required:
        - public_id
        - state
        - use_case
        - use_case_label
        - can_edit_samples
        - can_appeal
        - can_clone
        - can_delete
        - created_at
      title: RegistrationCampaign
      type: object
    ValidationError:
      properties:
        loc:
          description: Loc returned by the Sendora API.
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          description: Msg returned by the Sendora API.
          title: Message
          type: string
        type:
          description: Type returned by the Sendora API.
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    IssueOut:
      properties:
        field:
          description: Field returned by the Sendora API.
          title: Field
          type: string
        message:
          description: Message returned by the Sendora API.
          title: Message
          type: string
      required:
        - field
        - message
      title: IssueOut
      type: object
    CarrierOut:
      properties:
        name:
          description: Name returned by the Sendora API.
          title: Name
          type: string
        status:
          description: Status returned by the Sendora API.
          title: Status
          type: string
      required:
        - name
        - status
      title: CarrierOut
      type: object
    CampaignNumbersOut:
      properties:
        failed:
          default: []
          description: Failed returned by the Sendora API.
          items:
            $ref: '#/components/schemas/NumberFailureOut'
          title: Failed
          type: array
        items:
          description: Items returned by the Sendora API.
          items:
            $ref: '#/components/schemas/CampaignNumberOut'
          title: Items
          type: array
        total:
          description: Total returned by the Sendora API.
          title: Total
          type: integer
      required:
        - items
        - total
      title: CampaignNumbersOut
      type: object
    NumberFailureOut:
      properties:
        message:
          description: Message returned by the Sendora API.
          title: Message
          type: string
        public_id:
          description: The id of the number that could not be attached.
          title: Public Id
          type: string
      required:
        - public_id
        - message
      title: NumberFailureOut
      type: object
    CampaignNumberOut:
      properties:
        detail:
          default: ''
          description: Detail returned by the Sendora API.
          title: Detail
          type: string
        number:
          description: Number returned by the Sendora API.
          title: Number
          type: string
        public_id:
          description: 'The number''s id: the same `id` as in List numbers.'
          title: Public Id
          type: string
        status:
          description: Status returned by the Sendora API.
          title: Status
          type: string
      required:
        - public_id
        - number
        - status
      title: CampaignNumberOut
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Customer API key created in the Sendora dashboard.
      in: header
      name: X-API-Key
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.