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

# List sender names



## OpenAPI

````yaml /openapi/sms.json get /public/v1/sender-names
openapi: 3.0.3
info:
  title: Beem SMS API
  version: 1.0.0
  description: >-
    The Beem SMS API provides endpoints for sending SMS, checking balance,
    delivery reports, sender names, and SMS templates.
  contact:
    name: Beem
    url: https://beem.africa
    email: support@beem.africa
servers:
  - url: https://apisms.beem.africa
    description: Production server
  - url: https://dev-sms.beem.africa
    description: Staging server
security: []
tags: []
paths:
  /public/v1/sender-names:
    get:
      summary: List sender names
      operationId: listSenderNames
      parameters:
        - name: page
          in: query
          schema:
            description: Page number to retrieve (starts at 1).
            type: integer
            minimum: 1
          required: false
        - name: limit
          in: query
          schema:
            description: Maximum number of items to return per page.
            type: integer
            minimum: 1
          required: false
        - name: sortBy
          in: query
          schema:
            description: Field name to sort results by.
            type: string
          required: false
        - name: sortOrder
          in: query
          schema:
            description: 'Sort direction: ascending or descending.'
            enum:
              - asc
              - desc
              - ASC
              - DESC
            type: string
          required: false
        - name: q
          in: query
          schema:
            description: Search term to filter sender names.
            type: string
          required: false
        - name: status
          in: query
          schema:
            description: Filter by sender name status (e.g. active, pending).
            type: string
          required: false
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    description: List of sender names on your account.
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          description: Unique sender name record ID.
                          type: string
                        senderid:
                          description: Registered sender ID value.
                          type: string
                        sample_content:
                          description: Sample message submitted during registration.
                          type: string
                        status:
                          description: Approval status of the sender ID.
                          type: string
                        created:
                          description: >-
                            Timestamp when the sender name was created (ISO
                            8601).
                      additionalProperties: false
                  pagination:
                    type: object
                    properties:
                      totalItems:
                        description: Total number of items matching the query.
                        type: integer
                      currentPage:
                        description: Current page number (1-based).
                        type: integer
                      pageSize:
                        description: Number of items returned per page.
                        type: integer
                      totalPages:
                        description: Total number of pages available.
                        type: integer
                      startPage:
                        description: First page number in the current range.
                        type: integer
                      endPage:
                        description: Last page number in the current range.
                        type: integer
                      startIndex:
                        description: Zero-based index of the first item on this page.
                        type: integer
                      endIndex:
                        description: Zero-based index of the last item on this page.
                        type: integer
                      pages:
                        description: Page numbers available for navigation.
                        type: array
                        items:
                          type: integer
                    additionalProperties: false
                additionalProperties: false
        '401':
          description: Unauthorized — invalid or missing API credentials.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: API error code.
                    example: 120
                  message:
                    type: string
                    description: Error message.
                required:
                  - code
                  - message
                additionalProperties: true
              examples:
                invalidAuthentication:
                  summary: Invalid authentication
                  value:
                    code: 120
                    message: Invalid Authentication Parameters
      security:
        - basicAuth: []
        - accessToken: []
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'Beem API credentials: API key as username, API secret as password.'
    accessToken:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Access token only. Send as Authorization: <token> — do not use a Bearer
        prefix.

````