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

# List plugin connections

> Lists every plugin the tenant has connected, each with the catalog entry it
installs joined in — the data behind the installed-plugins screen. Disabled
connections are included (so the screen can offer to switch them back on);
deleted ones are not.

Each entry carries the connection's own `token` and its `settings`, which
hold the provider credentials — same payload the core-api handler returned.
Anyone authorized for the tenant can therefore read them.



## OpenAPI

````yaml /api/services-api.yaml get /v1/tenants/{tenantID}/plugins/connections
openapi: 3.0.3
info:
  description: >-
    Talqui is an omnichannel customer service platform that unifies
    conversations from WhatsApp, Instagram, Telegram, and many other channels
    into a single attendant panel, alongside a broader ecosystem of plugins and
    integrations. This API gives developers programmatic access to Talqui's
    services layer, exposing the operations needed to read and manage tenants,
    conversations, plugins, and related resources that power that platform.


    Authentication is available on behalf of an Operator (the default for this
    API), a Plugin Connection, or a Plugin — see the [Talqui authentication
    guide](https://docs.talqui.chat/guides/introduction/authentication/) for how
    each token is obtained and when to use it.


    Need help or have questions not covered here? Reach out to
    support@talqui.com.
  license:
    name: ISC
    url: https://opensource.org/license/isc-license-txt
  title: Talqui - Services API
  version: 0.65.0
servers:
  - description: Production
    url: https://services-api.talqui.chat
security: []
tags:
  - name: Tenants
  - name: Settings
  - name: Analytics
  - name: Campaigns
  - name: Campaigns models
  - name: Contacts
  - name: Handoff links
  - name: Inboxes
  - name: Messages
  - name: Notifications
  - name: Sessions
  - name: Operators
  - name: Plugins
  - name: Setup
  - name: Uploads
paths:
  /v1/tenants/{tenantID}/plugins/connections:
    get:
      tags:
        - Plugins
      summary: List plugin connections
      description: >-
        Lists every plugin the tenant has connected, each with the catalog entry
        it

        installs joined in — the data behind the installed-plugins screen.
        Disabled

        connections are included (so the screen can offer to switch them back
        on);

        deleted ones are not.


        Each entry carries the connection's own `token` and its `settings`,
        which

        hold the provider credentials — same payload the core-api handler
        returned.

        Anyone authorized for the tenant can therefore read them.
      operationId: ListPluginConnectionsController
      parameters:
        - in: path
          name: tenantID
          required: true
          schema:
            description: The tenant whose plugin connections are being listed.
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    additionalProperties: false
                    properties:
                      pluginConnections:
                        description: Plugin connections belonging to the tenant.
                        items:
                          additionalProperties: false
                          properties:
                            createdAt:
                              description: When the connection was created.
                              format: date-time
                              type: string
                            deadAt:
                              description: >-
                                When the connection turned DEAD, while it stays
                                so.
                              format: date-time
                              nullable: true
                              type: string
                            deletedAt:
                              description: >-
                                Always absent here — deleted connections are not
                                listed.
                              format: date-time
                              nullable: true
                              type: string
                            disabled:
                              description: Whether the tenant switched this connection off.
                              type: boolean
                            lastAssertAt:
                              description: When the connection was last asserted.
                              format: date-time
                              nullable: true
                              type: string
                            lastAssertStatus:
                              description: Outcome of the last assertion run.
                              enum:
                                - PENDING
                                - SUCCESS
                                - FAILED
                              type: string
                            lastHealthCheckAt:
                              description: When the connection was last health-checked.
                              format: date-time
                              nullable: true
                              type: string
                            lastHealthStatus:
                              description: Resolved state of the last health check.
                              enum:
                                - HEALTHY
                                - SICK
                                - DEAD
                              type: string
                            nextAssertAt:
                              description: When the next assertion is due.
                              format: date-time
                              nullable: true
                              type: string
                            nextHealthCheckAt:
                              description: When the next health check is due.
                              format: date-time
                              nullable: true
                              type: string
                            plugin:
                              additionalProperties: false
                              description: The catalog plugin this connection points at.
                              nullable: true
                              properties:
                                pluginDescription:
                                  description: Long-form description of the plugin.
                                  type: string
                                pluginID:
                                  description: The catalog plugin identifier.
                                  type: string
                                pluginIcon:
                                  description: Icon URL, when set.
                                  nullable: true
                                  type: string
                                pluginMCPSettings:
                                  additionalProperties: false
                                  description: >-
                                    How the plugin exposes its MCP server, when
                                    it does.
                                  nullable: true
                                  properties:
                                    mcpRequest:
                                      additionalProperties: false
                                      nullable: true
                                      properties:
                                        address:
                                          nullable: true
                                          type: string
                                        headers:
                                          additionalProperties: {}
                                          type: object
                                        method:
                                          nullable: true
                                          type: string
                                      required:
                                        - address
                                        - method
                                        - headers
                                      type: object
                                    method:
                                      nullable: true
                                      type: string
                                  required:
                                    - method
                                    - mcpRequest
                                  type: object
                                pluginName:
                                  description: Display name of the plugin.
                                  type: string
                                pluginPresentations:
                                  description: >-
                                    Marketplace presentations, when the plugin
                                    fans out into several cards.
                                  items:
                                    additionalProperties: false
                                    properties:
                                      adapter:
                                        type: string
                                      pluginCategory:
                                        nullable: true
                                        type: string
                                      pluginColor:
                                        nullable: true
                                        type: string
                                      pluginDescription:
                                        nullable: true
                                        type: string
                                      pluginIcon:
                                        nullable: true
                                        type: string
                                      pluginName:
                                        nullable: true
                                        type: string
                                      pluginSlug:
                                        nullable: true
                                        type: string
                                      pluginSummary:
                                        nullable: true
                                        type: string
                                      presentationKey:
                                        type: string
                                    required:
                                      - presentationKey
                                      - adapter
                                      - pluginName
                                      - pluginIcon
                                      - pluginSummary
                                      - pluginDescription
                                      - pluginSlug
                                      - pluginCategory
                                      - pluginColor
                                    type: object
                                  nullable: true
                                  type: array
                                pluginURN:
                                  description: >-
                                    Internal plugin URN, e.g.
                                    `urn:talqui:whatsapp:0`.
                                  nullable: true
                                  type: string
                                pluginVariables:
                                  description: >-
                                    Variables a connection to this plugin can
                                    declare.
                                  items:
                                    additionalProperties: false
                                    properties:
                                      variableDescription:
                                        nullable: true
                                        type: string
                                      variableKey:
                                        type: string
                                      variableLabel:
                                        type: string
                                      variableOptions:
                                        items:
                                          additionalProperties: false
                                          properties:
                                            label:
                                              type: string
                                            value:
                                              type: string
                                          required:
                                            - label
                                            - value
                                          type: object
                                        nullable: true
                                        type: array
                                      variableType:
                                        enum:
                                          - string
                                          - select
                                        type: string
                                    required:
                                      - variableLabel
                                      - variableKey
                                      - variableType
                                      - variableDescription
                                      - variableOptions
                                    type: object
                                  nullable: true
                                  type: array
                              required:
                                - pluginID
                                - pluginURN
                                - pluginName
                                - pluginDescription
                                - pluginIcon
                                - pluginMCPSettings
                                - pluginVariables
                                - pluginPresentations
                              type: object
                            pluginConnectionID:
                              description: The connection identifier.
                              type: string
                            pluginConnectionLabel:
                              description: Label the tenant gave this connection.
                              nullable: true
                              type: string
                            pluginURN:
                              description: URN of the plugin this connection installs.
                              type: string
                            settings:
                              additionalProperties: {}
                              description: >-
                                Provider configuration for this connection,
                                including its credentials.
                              type: object
                            sickAt:
                              description: >-
                                When the connection first turned SICK, while it
                                stays so.
                              format: date-time
                              nullable: true
                              type: string
                            tenantID:
                              description: The tenant that owns this connection.
                              type: string
                            token:
                              description: >-
                                Credential of this connection, used to
                                authenticate as it.
                              nullable: true
                              type: string
                            updatedAt:
                              description: When the connection was last updated.
                              format: date-time
                              type: string
                          required:
                            - pluginConnectionID
                            - pluginURN
                            - tenantID
                            - pluginConnectionLabel
                            - token
                            - settings
                            - lastHealthStatus
                            - lastHealthCheckAt
                            - nextHealthCheckAt
                            - lastAssertStatus
                            - lastAssertAt
                            - nextAssertAt
                            - sickAt
                            - deadAt
                            - disabled
                            - createdAt
                            - updatedAt
                            - plugin
                          type: object
                        type: array
                    required:
                      - pluginConnections
                    type: object
                required:
                  - data
                type: object
          description: Response for status 200.
        '400':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      oneOf:
                        - $ref: '#/components/schemas/MissingTenantIDError'
                        - $ref: '#/components/schemas/RequestValidationError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            MissingTenantIDError (error_code 1001): tenantID absent from the
            URL. | RequestValidationError (error_code 1002): params fail schema
            validation.
        '401':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/UnauthorizedError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: 'UnauthorizedError (error_code 1003): missing/invalid operator token.'
        '403':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/ForbiddenError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            ForbiddenError (error_code 1004): operator does not belong to this
            tenant.
        '500':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      $ref: '#/components/schemas/UnknownError'
                    maxItems: 1
                    minItems: 1
                    type: array
                required:
                  - errors
                type: object
          description: >-
            UnknownError (error_code 5999): Unexpected internal error not
            otherwise documented for this endpoint.
components:
  schemas:
    MissingTenantIDError:
      additionalProperties: false
      properties:
        error:
          enum:
            - MissingTenantIDError
          type: string
        error_code:
          enum:
            - 1001
          type: number
        message:
          example: tenantID is required.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    RequestValidationError:
      additionalProperties: false
      properties:
        error:
          enum:
            - RequestValidationError
          type: string
        error_code:
          enum:
            - 1002
          type: number
        fields:
          items:
            additionalProperties: false
            properties:
              allowed:
                type: string
              field:
                type: string
              received:
                type: string
            required:
              - field
              - received
              - allowed
            type: object
          type: array
        message:
          example: Invalid request data.
          type: string
        statusCode:
          enum:
            - 400
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
        - fields
      type: object
    UnauthorizedError:
      additionalProperties: false
      properties:
        error:
          enum:
            - UnauthorizedError
          type: string
        error_code:
          enum:
            - 1003
          type: number
        message:
          example: You are not authorized to perform this request.
          type: string
        statusCode:
          enum:
            - 401
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    ForbiddenError:
      additionalProperties: false
      properties:
        error:
          enum:
            - ForbiddenError
          type: string
        error_code:
          enum:
            - 1004
          type: number
        message:
          example: You do not have access to this resource.
          type: string
        statusCode:
          enum:
            - 403
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object
    UnknownError:
      additionalProperties: false
      properties:
        error:
          enum:
            - UnknownError
          type: string
        error_code:
          enum:
            - 5999
          type: number
        message:
          example: For some unknown reason your request has not succeeded.
          type: string
        statusCode:
          enum:
            - 500
          type: number
      required:
        - statusCode
        - error
        - error_code
        - message
      type: object

````

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