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

# List sender IDs

> Lists the sender IDs declared on one of your accounts, with their review status. Requires the `PARTNER` scope.

> [!NOTE]
>
> **Required scope:** `PARTNER`

Lists the sender IDs declared on one of your accounts, with the review status of each one. An account holds at most 3 sender IDs.

* `page` starts at 1 and `size` defaults to 20, up to 100. The response carries the usual `pagination` object, see [Pagination](https://help.withallo.com/en/v2/api-reference/guides/pagination.md).
* `status` is `PENDING`, `VALIDATED`, `FAILED` or `DISABLED`. See [Get sender ID](https://help.withallo.com/en/v2/api-reference/white-label/get-sender-id.md) for what each one means.
* An account your API key did not create returns `404 PARTNER_ACCOUNT_NOT_FOUND`.

To declare a sender ID, call [Declare sender ID](https://help.withallo.com/en/v2/api-reference/white-label/create-sender-id.md).


## OpenAPI

````yaml GET /v2/api/partner/accounts/{account_id}/sender_ids
openapi: 3.0.3
info:
  title: Allo API
  description: >-
    Allo API provides programmatic access to your Allo account, allowing you to
    manage webhooks, retrieve calls and contacts, and send SMS messages.


    All requests to `/v1/api/**` endpoints automatically go through quota
    checking and scope validation.
  version: 1.0.0
  contact:
    name: Allo Support
servers:
  - url: https://api.withallo.com
    description: Production server
security: []
tags:
  - name: Summary Templates
    description: >-
      Manage call summary templates that control how AI-generated call summaries
      are structured for your team.
  - name: Webhooks
    description: >-
      Manage webhook endpoints to receive real-time notifications about events
      in your Allo account. Each endpoint subscribes to one or more event topics
      and is verified with a signing secret.
  - name: Calls
    description: >-
      Retrieve and search call records with filtering and pagination. Filter
      calls by your Allo phone number.
  - name: Contacts
    description: >-
      Search and retrieve contact information with sorting and pagination.
      Includes engagement level tracking.
  - name: SMS
    description: Send SMS messages to phone numbers using your Allo numbers.
  - name: Fax
    description: >-
      Send a PDF as a fax from an Allo line with fax turned on. Sent and
      received faxes appear in conversation items.
  - name: Phone Numbers
    description: Retrieve information about your Allo phone numbers.
  - name: Analytics
    description: Pre-computed call metrics, team performance, and outbound dial funnel
  - name: CRM
    description: Manage people, companies, and deals in your CRM.
  - name: Notes
    description: >-
      Internal team notes on conversations and CRM people, with @mention
      support. Notes are never visible to the contact.
  - name: Threads
    description: >-
      Team discussion threads attached to a conversation item (call, SMS, or
      conversation note). One thread per item.
  - name: AI Receptionist
    description: >-
      Read and write the AI receptionist configuration of a phone line: business
      details, voice, prompt, capabilities, business hours, transfer rules,
      scheduling calendars and knowledge sources.
  - name: Inboxes
    description: >-
      Personal inboxes: saved views of one or more lines, optionally narrowed to
      phone-menu options, with their own filters and notification setting.
paths:
  /v2/api/partner/accounts/{account_id}/sender_ids:
    get:
      tags:
        - White label
      summary: List sender IDs
      description: >-
        Lists the sender IDs declared on one of your accounts, with their review
        status. Requires the `PARTNER` scope.
      operationId: listPartnerSenderIds
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: string
          description: The account id returned by Create account (`usr-*`).
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Size'
      responses:
        '200':
          description: The account's sender IDs
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PartnerSenderId'
                  pagination:
                    $ref: '#/components/schemas/ApiPagination'
              example:
                data:
                  - id: vsi-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61
                    account_id: usr-575966AF3661061265263C58882BC409D2A427B8
                    partner_client_ref: crm-12345
                    sender_id: PLOMBMARTIN
                    status: PENDING
                    example_content: >-
                      Bonjour, votre intervention est confirmée demain à 9h.
                      Plomberie Martin
                    created_at: '2026-11-16T10:05:00'
                pagination:
                  page: 1
                  size: 20
                  total_count: 1
                  total_pages: 1
                  has_more: false
        '401':
          $ref: '#/components/responses/ApiUnauthorized'
        '403':
          description: The API key lacks the PARTNER scope.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
        '404':
          description: >-
            No account with this id was provisioned by your API key
            (PARTNER_ACCOUNT_NOT_FOUND).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
        '429':
          $ref: '#/components/responses/ApiRateLimited'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    Page:
      name: page
      in: query
      description: Page number (1-indexed)
      schema:
        type: integer
        default: 1
        minimum: 1
    Size:
      name: size
      in: query
      description: Results per page
      schema:
        type: integer
        default: 20
        minimum: 1
        maximum: 100
  schemas:
    PartnerSenderId:
      type: object
      description: An alphanumeric sender ID declared on an account you provisioned.
      properties:
        id:
          type: string
          description: The sender ID's id (`vsi-*`).
          example: vsi-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61
        account_id:
          type: string
          description: The account the sender ID is declared on.
          example: usr-575966AF3661061265263C58882BC409D2A427B8
        partner_client_ref:
          type: string
          nullable: true
          description: Your own reference, set when the account was created.
          example: crm-12345
        sender_id:
          type: string
          description: The name recipients see instead of a phone number.
          example: PLOMBMARTIN
        status:
          type: string
          enum:
            - PENDING
            - VALIDATED
            - FAILED
            - DISABLED
          description: >-
            `PENDING`: waiting for Allo's review. `VALIDATED`: approved, the
            account can send SMS with it. `FAILED`: rejected, declare another
            name. `DISABLED`: deactivated by Allo after validation, sending with
            it is refused.
          example: PENDING
        example_content:
          type: string
          nullable: true
          description: The example message sent with the declaration.
          example: >-
            Bonjour, votre intervention est confirmée demain à 9h. Plomberie
            Martin
        created_at:
          type: string
          format: date-time
          description: When the sender ID was declared.
          example: '2026-11-16T10:05:00'
    ApiPagination:
      type: object
      properties:
        page:
          type: integer
          example: 1
        size:
          type: integer
          example: 20
        total_count:
          type: integer
          format: int64
          example: 1
        total_pages:
          type: integer
          example: 1
        has_more:
          type: boolean
          example: false
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            request_id:
              type: string
            retry_after_seconds:
              type: integer
              nullable: true
  responses:
    ApiUnauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ApiRateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization

````

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