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

# List Whatsapp signup sessions

> List finished WhatsApp Embedded Signup sessions, with status `SUCCESS` or `FAILURE`, newest first. Use the `errors` of a failed session to see why provisioning stopped.



## OpenAPI

````yaml /openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/signup
openapi: 3.1.0
info:
  contact:
    email: support@telnyx.com
  description: >
    API for managing WhatsApp Business Accounts (WABAs), phone numbers, and
    message templates.


    Use these endpoints to:

    - List and manage WhatsApp Business Accounts

    - Configure phone numbers for WhatsApp

    - Create and manage message templates

    - Set up webhook configurations
  title: Telnyx WhatsApp Management API
  version: 2.0.0
servers:
  - url: https://api.telnyx.com/v2
security:
  - bearerAuth: []
paths:
  /whatsapp/signup:
    get:
      tags:
        - Whatsapp Signup
      summary: List Whatsapp signup sessions
      description: >-
        List finished WhatsApp Embedded Signup sessions, with status `SUCCESS`
        or `FAILURE`, newest first. Use the `errors` of a failed session to see
        why provisioning stopped.
      operationId: ListWhatsappSignupSessions
      parameters:
        - $ref: '#/components/parameters/PageConsolidated'
        - name: filter[waba_id]
          in: query
          schema:
            type: string
          description: Filter by Meta WABA ID
        - name: filter[customer_id]
          in: query
          schema:
            type: string
          description: Filter by the tech provider customer reference
        - name: filter[created_at][gte]
          in: query
          schema:
            type: string
            format: date-time
          description: Return sessions created at or after this time (RFC 3339)
        - name: filter[created_at][lte]
          in: query
          schema:
            type: string
            format: date-time
          description: Return sessions created at or before this time (RFC 3339)
      responses:
        '200':
          $ref: '#/components/responses/WhatsappSignupSessionListResponse'
          description: Whatsapp signup sessions list
        4XX:
          $ref: '#/components/responses/messaging_GenericErrorResponse'
components:
  parameters:
    PageConsolidated:
      name: page
      in: query
      style: deepObject
      explode: true
      description: >-
        Consolidated page parameter (deepObject style). Originally:
        page[number], page[size]
      schema:
        type: object
        properties:
          number:
            type: integer
            minimum: 1
            default: 1
            description: The page number to load
          size:
            type: integer
            minimum: 1
            maximum: 250
            default: 20
            description: The size of the page
  responses:
    WhatsappSignupSessionListResponse:
      description: Successful response with a list of WhatsApp signup sessions
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  $ref: '#/components/schemas/WhatsappSignupSession'
              meta:
                $ref: '#/components/schemas/messaging_PaginationMeta'
          example:
            data:
              - record_type: whatsapp_session_id
                session_id: 019f4253-e09a-7622-bc6f-625378711d78
                user_id: 00000000-0000-4000-8000-000000000000
                state: SHARE_CREDIT_LINE
                status: FAILURE
                created_at: '2026-10-01T09:58:25Z'
                updated_at: '2026-10-01T09:58:27Z'
                waba_id: '123456789012345'
                customer_id: acme-corp-42
                errors:
                  - >-
                    [ShareCreditLine] Bad status received: Invalid parameter
                    Credit Allocation Not Allowed During Month-End Close: This
                    WhatsApp Business Account cannot be moved onto a credit line
                    while the monthly billing close is running. Please try again
                    once the close has completed, usually within the first few
                    days of the month.
            meta:
              page_number: 1
              page_size: 20
              total_pages: 1
              total_results: 1
    messaging_GenericErrorResponse:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/messaging_Errors'
          example:
            errors:
              - code: string
                title: string
                detail: string
                source:
                  pointer: /data/attributes/phone_number
                  parameter: string
  schemas:
    WhatsappSignupSession:
      type: object
      properties:
        record_type:
          type: string
          enum:
            - whatsapp_session_id
        session_id:
          type: string
          description: Signup session ID
        user_id:
          type: string
          description: Telnyx user ID that owns the signup session
        state:
          type: string
          enum:
            - SUBSCRIBE_WEBHOOKS
            - ASSIGNED_USERS
            - SHARE_CREDIT_LINE
            - REGISTER_PHONE_NUMBER
            - ADD_WABA_TO_DB
            - ADD_PHONE_NUMBERS_TO_DB
            - COMPLETE
          description: >-
            Current provisioning step, or the step that failed.
            `REGISTER_PHONE_NUMBER` is skipped for coexistence signups.
        status:
          type: string
          enum:
            - INCOMPLETE
            - PENDING
            - SUCCESS
            - FAILURE
          description: >-
            `INCOMPLETE` waits for the Meta signup code, `PENDING` is in
            progress, `SUCCESS` finished provisioning, and `FAILURE` stopped at
            `state`.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        waba_id:
          type: string
          description: Meta WhatsApp Business Account ID
        customer_id:
          type: string
          description: Tech provider customer reference submitted with the signup
        errors:
          type: array
          items:
            type: string
          description: Errors recorded during provisioning
    messaging_PaginationMeta:
      type: object
      required:
        - total_pages
        - total_results
        - page_size
        - page_number
      properties:
        total_pages:
          type: integer
          example: 3
        total_results:
          type: integer
          example: 55
        page_number:
          type: integer
          example: 2
        page_size:
          type: integer
          example: 25
    messaging_Errors:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/messaging_Error'
    messaging_Error:
      required:
        - code
        - title
      properties:
        code:
          type: string
          x-format: integer
        title:
          type: string
        detail:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
              format: json-pointer
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````