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

# Get the website chat

> Reads the website chat of the tenant and the snippet to embed it. Answers `{"configured": false}` before one exists. Needs the `channels:read` scope.



## OpenAPI

````yaml /openapi/partner.yaml get /api/v1/partner/tenants/{external_ref}/channels/website/
openapi: 3.1.0
info:
  title: ImpelLabs Partner API
  version: '1'
  description: >-
    The Partner API provisions customer businesses (tenants) and runs their
    channels, conversations and templates from your own product. Call it from
    your server with a partner key. Every path ends with a slash.
servers:
  - url: https://api.impellabs.tech
security:
  - bearer: []
tags:
  - name: Keys
    description: Your partner API keys.
  - name: Tenants
    description: Customer businesses, their channels, conversations and templates.
  - name: Webhooks
    description: Where your tenants' events go.
  - name: WhatsApp sign-up
    description: The settings of the hosted WhatsApp sign-up.
paths:
  /api/v1/partner/tenants/{external_ref}/channels/website/:
    get:
      tags:
        - Tenants
      summary: Get the website chat
      description: >-
        Reads the website chat of the tenant and the snippet to embed it.
        Answers `{"configured": false}` before one exists. Needs the
        `channels:read` scope.
      operationId: get_api_v1_partner_tenants_external_ref_channels_website
      parameters:
        - name: external_ref
          in: path
          required: true
          schema:
            type: string
          description: Your own id for the customer business, set when you created it.
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                configured: true
                id: 3b4c5d6e-0000-4000-8000-000000000000
                name: Website chat
                public_key: PUBLIC_KEY
                allowed_origins:
                  - https://example.org
                brand_color: '#1e417d'
                is_active: true
                sdk_url: https://cdn.impellabs.tech/sdk/impel-chat.js
                api_base_url: https://api.impellabs.tech/api/v1
                embed_snippet: >-
                  <script src="https://cdn.impellabs.tech/sdk/impel-chat.js"
                  data-impel-key="PUBLIC_KEY"
                  data-api-base-url="https://api.impellabs.tech/api/v1"
                  data-brand-color="#1e417d" defer></script>
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        4XX:
          description: The request is not valid or not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  responses:
    Unauthorized:
      description: The credentials are missing, wrong, expired or revoked.
    Forbidden:
      description: These credentials may not do this.
    NotFound:
      description: There is no such row, or these credentials cannot see it.
  schemas:
    Error:
      type: object
      description: >-
        An error. Most errors carry `detail`. Some carry `error` with `code` and
        `message`.
      properties:
        detail:
          type: string
        code:
          type: string
        field:
          type: string
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

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