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

# Get a Whatsapp hosted signup

> Retrieve a hosted signup and its onboarding URL.



## OpenAPI

````yaml /openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/hosted_signups/{id}
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/hosted_signups/{id}:
    get:
      tags:
        - Whatsapp Signup
      summary: Get a Whatsapp hosted signup
      description: Retrieve a hosted signup and its onboarding URL.
      operationId: GetWhatsappHostedSignup
      parameters:
        - $ref: '#/components/parameters/WhatsappHostedSignupId'
      responses:
        '200':
          $ref: '#/components/responses/WhatsappHostedSignupResponse'
          description: Whatsapp hosted signup
        '404':
          description: Hosted signup not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messaging_Errors'
              example:
                errors:
                  - code: '10005'
                    title: Resource not found
                    detail: The requested resource or URL could not be found
        4XX:
          $ref: '#/components/responses/messaging_GenericErrorResponse'
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Telnyx from 'telnyx';

            const client = new Telnyx({
              apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
            });

            const response = await client.whatsapp.hostedSignups.retrieve('id');

            console.log(response.data);
        - lang: Python
          source: |
            import os
            from telnyx import Telnyx

            client = Telnyx(
                api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
            )
            response = client.whatsapp.hosted_signups.retrieve(
                "id",
            )
            print(response.data)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/team-telnyx/telnyx-go\"\n\t\"github.com/team-telnyx/telnyx-go/option\"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\thostedSignup, err := client.Whatsapp.HostedSignups.Get(\n\t\tcontext.TODO(),\n\t\t\"id\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", hostedSignup.Data)\n}\n"
        - lang: Java
          source: |-
            package com.telnyx.sdk.example;

            import com.telnyx.sdk.client.TelnyxClient;
            import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

            public final class Main {
                private Main() {}

                public static void main(String[] args) {
                    TelnyxClient client = TelnyxOkHttpClient.fromEnv();

                    var response = client.whatsapp().hostedSignups().retrieve("id");
                }
            }
        - lang: Ruby
          source: |-
            require "telnyx"

            telnyx = Telnyx::Client.new(api_key: "My API Key")

            response = telnyx.whatsapp.hosted_signups.retrieve("id")

            puts(response)
        - lang: PHP
          source: >-
            <?php


            require_once dirname(__DIR__) . '/vendor/autoload.php';


            use Telnyx\Client;

            use Telnyx\Core\Exceptions\APIException;


            $client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API
            Key');


            try {
              $response = $client->whatsapp->hostedSignups->retrieve(
                'id',
              );

              var_dump($response);
            } catch (APIException $e) {
              echo $e->getMessage();
            }
        - lang: CLI
          source: |-
            telnyx whatsapp:hosted-signups retrieve \
              --api-key 'My API Key' \
              --id id
components:
  parameters:
    WhatsappHostedSignupId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: Hosted signup ID returned when the hosted signup was created
  responses:
    WhatsappHostedSignupResponse:
      description: Successful response with a WhatsApp hosted signup
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                $ref: '#/components/schemas/WhatsappHostedSignup'
          example:
            data:
              id: 0192345a-7b8c-7d9e-0f12-3456789abcde
              record_type: whatsapp_jwt
              app_id: '123456789012345'
              created_at: '2026-07-08T12:00:00Z'
              expires_at: '2026-07-09T12:00:00Z'
              jwt: eyJhbGciOiJSUzI1NiIs...
              url: https://acct.fyi?token=eyJhbGciOiJSUzI1NiIs...
    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:
    messaging_Errors:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/messaging_Error'
    WhatsappHostedSignup:
      type: object
      properties:
        id:
          type: string
          description: Hosted signup ID
          example: 0192345a-7b8c-7d9e-0f12-3456789abcde
        record_type:
          type: string
          enum:
            - whatsapp_jwt
          example: whatsapp_jwt
        app_id:
          type: string
          description: Meta App ID the hosted signup onboards customers into
          example: '123456789012345'
        solution_id:
          type: string
          description: >-
            Meta Partner Solution ID linked to the app. Returned only when
            creating a hosted signup.
          example: '987654321098765'
        created_at:
          type: string
          format: date-time
          example: '2026-07-08T12:00:00Z'
        expires_at:
          type: string
          format: date-time
          description: When the onboarding URL stops working
          example: '2026-07-09T12:00:00Z'
        jwt:
          type: string
          description: Signed token embedded in `url`
          example: eyJhbGciOiJSUzI1NiIs...
        url:
          type: string
          format: uri
          description: Hosted onboarding URL to share with the end customer
          example: https://acct.fyi?token=eyJhbGciOiJSUzI1NiIs...
    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

````