> ## 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.

# Obtenir un Sender ID

> Returns a sender ID declared on one of your accounts, with its review status. Use it to poll the status if you do not receive webhooks, and to see whether Allo disabled it. Requires the `PARTNER` scope.

> [!NOTE]
>
> **Scope requis :** `PARTNER`

Renvoie un Sender ID déclaré sur l'un de vos comptes, avec son statut de validation. Les webhooks [`partner.sender_id.validated`](https://help.withallo.com/fr/v2/api-reference/webhooks/event-catalog#partnersender_idvalidated) et [`partner.sender_id.failed`](https://help.withallo.com/fr/v2/api-reference/webhooks/event-catalog#partnersender_idfailed) vous préviennent à la fin de la validation. Sans endpoint webhook, interrogez cet endpoint à la place, dans la [limite](https://help.withallo.com/fr/v2/api-reference/guides/rate-limits.md) de 20 requêtes de lecture par seconde et par clé.

| `status` | Signification |
| - | - |
| `PENDING` | Le Sender ID attend la validation d'Allo, en général 1 à 5 jours ouvrés. |
| `VALIDATED` | Allo a validé le Sender ID. Le compte peut envoyer des SMS avec lui. |
| `FAILED` | Allo a refusé le Sender ID. Déclarez un autre nom avec [Déclarer un Sender ID](https://help.withallo.com/fr/v2/api-reference/white-label/create-sender-id.md). |
| `DISABLED` | Allo a désactivé le Sender ID après l'avoir validé. L'envoi de SMS avec lui est refusé. |

Allo n'envoie aucun webhook quand un Sender ID passe à `DISABLED`. Consultez cet endpoint pour vérifier qu'un Sender ID validé est toujours utilisable.

Un `id` qui n'est pas un Sender ID de ce compte échoue avec `404 PARTNER_SENDER_ID_NOT_FOUND`. Un compte que votre clé API n'a pas créé renvoie `404 PARTNER_ACCOUNT_NOT_FOUND`.


## OpenAPI

````yaml GET /v2/api/partner/accounts/{account_id}/sender_ids/{id}
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/{id}:
    get:
      tags:
        - White label
      summary: Get sender ID
      description: >-
        Returns a sender ID declared on one of your accounts, with its review
        status. Use it to poll the status if you do not receive webhooks, and to
        see whether Allo disabled it. Requires the `PARTNER` scope.
      operationId: getPartnerSenderId
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: string
          description: The account id returned by Create account (`usr-*`).
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The sender ID's id returned by Declare sender ID (`vsi-*`).
      responses:
        '200':
          description: Sender ID
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PartnerSenderId'
              example:
                data:
                  id: vsi-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61
                  account_id: usr-575966AF3661061265263C58882BC409D2A427B8
                  partner_client_ref: crm-12345
                  sender_id: PLOMBMARTIN
                  status: VALIDATED
                  example_content: >-
                    Bonjour, votre intervention est confirmée demain à 9h.
                    Plomberie Martin
                  created_at: '2026-11-16T10:05:00'
        '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: >-
            The account was not provisioned by your API key
            (PARTNER_ACCOUNT_NOT_FOUND), or no sender ID with this id is
            declared on the account (PARTNER_SENDER_ID_NOT_FOUND).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
        '429':
          $ref: '#/components/responses/ApiRateLimited'
      security:
        - ApiKeyAuth: []
components:
  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'
    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.