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

# See which adapter keys an account has connected

> Widget adapters are capabilities a widget can use, and some of them act through a service the owner has an
account with: an adapter that sends email needs the owner's email provider key, one that sends texts needs the
owner's SMS provider key. This lists every key an adapter takes from an owner and whether this account has
connected it, so a settings page can show what is missing.

An empty list means no adapter takes a key from an owner at the moment. The list never contains a key: only
whether one is connected and when it was last set.

Connect a key with `setUserAdapterConnection`; take it away with `removeUserAdapterConnection`. The widgets of
customers a partner manages use the partner's keys instead (`getPartnerAdapterConnections`).

The caller must be the account itself (an API key of that account works, with the `account:read` scope), or a
Widgetic administrator.




## OpenAPI

````yaml /openapi/widgetic-api-public.json get /users/{userId}/adapter-connections
openapi: 3.0.0
info:
  title: Widgetic API Gateway
  version: 1.0.0
  description: API documentation for the Widgetic API Gateway
  license:
    name: Widgetic Integration License
    url: https://docs.widgetic.com/resources/license
servers:
  - url: https://api.widgetic.com/v1
    description: Production server
    variables:
      env:
        default: production
        description: Environment
      apiUrl:
        default: https://api.widgetic.com
        description: API URL
      apiVersion:
        default: /v1
        description: API Version path prefix
security: []
tags: []
paths:
  /users/{userId}/adapter-connections:
    get:
      tags:
        - Users
      summary: See which adapter keys an account has connected
      description: >
        Widget adapters are capabilities a widget can use, and some of them act
        through a service the owner has an

        account with: an adapter that sends email needs the owner's email
        provider key, one that sends texts needs the

        owner's SMS provider key. This lists every key an adapter takes from an
        owner and whether this account has

        connected it, so a settings page can show what is missing.


        An empty list means no adapter takes a key from an owner at the moment.
        The list never contains a key: only

        whether one is connected and when it was last set.


        Connect a key with `setUserAdapterConnection`; take it away with
        `removeUserAdapterConnection`. The widgets of

        customers a partner manages use the partner's keys instead
        (`getPartnerAdapterConnections`).


        The caller must be the account itself (an API key of that account works,
        with the `account:read` scope), or a

        Widgetic administrator.
      operationId: getUserAdapterConnections
      parameters:
        - in: path
          name: userId
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            The account whose adapter keys to list. For your own, your own user
            id
      responses:
        '200':
          description: Every key an adapter takes from an owner, connected or not
          content:
            application/json:
              schema:
                title: AdapterConnectionListResponse
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AdapterConnection'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                  - success
                  - data
        '400':
          description: The account id is not a valid id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The API key is missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The keys belong to another account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests. Wait a minute.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: >-
            Adapter keys cannot be read on this server right now
            (ADAPTER_CONNECTIONS_UNAVAILABLE)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
      x-code-samples:
        - lang: TypeScript
          label: TypeScript SDK
          source: >
            import { Configuration, UsersApi } from '@widgetic/api-sdk-ts';


            const usersApi = new UsersApi(new Configuration({ apiKey:
            'YOUR_API_KEY' }));


            const { data: connections } = await
            usersApi.getUserAdapterConnections({ userId });

            const missing = connections.filter((connection) =>
            !connection.connected);

            console.log(missing.map((connection) => connection.label));
components:
  schemas:
    AdapterConnection:
      type: object
      description: >-
        A key an adapter can take from an account, and whether the account has
        connected it. The key itself is never part of this: it is given once,
        when it is connected, and Widgetic keeps it encrypted.
      required:
        - adapterId
        - adapterLabel
        - credentialKey
        - label
        - scope
        - connected
        - updatedAt
        - confirmation
        - awaitingConfirmation
        - confirmedAt
      properties:
        adapterId:
          type: string
          description: The adapter the key is for (its id in the adapter catalog)
          example: email
        adapterLabel:
          type: string
          description: What the adapter is called to its owner
          example: Email
        credentialKey:
          type: string
          description: >-
            The name of the key within the adapter. Use it, with the adapter id,
            to connect or remove the key
          example: resendApiKey
        label:
          type: string
          description: What the key is called to its owner
          example: Resend API key
        scope:
          type: string
          enum:
            - owner
            - partner
            - owner_or_partner
          description: >-
            Who may keep this key. `owner` is the person who made the widget, in
            their own account. `partner` is a partner, for the widgets of the
            customers it manages. `owner_or_partner` is either; for a widget of
            a managed customer the partner's key is used.
        connected:
          type: boolean
          description: Whether this account has connected the key
        updatedAt:
          type: string
          format: date-time
          nullable: true
          description: When the key was last set. Null when it is not connected
        confirmation:
          type: string
          nullable: true
          description: >-
            How this credential is proved before it is used. `email_code` means
            it is an email address: saving it emails a code to it, and it is
            used only after the code is given back
            (`confirmUserAdapterConnection`, `confirmPartnerAdapterConnection`).
            Null for a credential that is used as soon as it is saved
          example: email_code
        awaitingConfirmation:
          type: boolean
          description: >-
            True when the credential is connected but has not been confirmed
            yet, so no adapter uses it. Always false when `confirmation` is null
            or the credential is not connected
        confirmedAt:
          type: string
          format: date-time
          nullable: true
          description: >-
            When the credential was confirmed. Null when it is not connected, is
            awaiting its code, or needs no confirmation
      example:
        adapterId: email
        adapterLabel: Email
        credentialKey: resendApiKey
        label: Resend API key
        scope: Example scope
        connected: true
        updatedAt: '2026-01-15T09:30:00.000Z'
        confirmation: email_code
        awaitingConfirmation: true
        confirmedAt: '2026-01-15T09:30:00.000Z'
    ResponseMeta:
      type: object
      description: >-
        Extra information about the answer: where a page sits in a list, the
        cursor of the next page, or warnings about a call that succeeded with a
        caveat.
      additionalProperties: true
      properties:
        page:
          type: integer
          description: The page that was read, counting from 1.
          example: 1
        size:
          type: integer
          description: How many items one page holds.
          example: 20
        total:
          type: integer
          description: How many items the whole list has.
          example: 135
        limit:
          type: integer
          description: The same as `size`.
          example: 20
        offset:
          type: integer
          description: How many items come before this page.
          example: 0
        hasNextPage:
          type: boolean
          example: true
        hasPreviousPage:
          type: boolean
          example: false
        nextCursor:
          type: string
          nullable: true
          description: >-
            Pass this as `cursor` to read the next page of a list that is read
            by cursor. `null` on the last page.
        warnings:
          type: array
          items:
            type: string
          description: >-
            Things the call did not do, though it succeeded (for example a table
            that could not be created just now).
    ErrorResponse:
      type: object
      required:
        - success
        - message
        - error
      additionalProperties: true
      properties:
        success:
          type: boolean
          description: Always `false` on a failure.
          example: false
        message:
          type: string
          description: The same text as `error.message`, for a caller that reads one line.
        error:
          $ref: '#/components/schemas/ErrorDetail'
    ErrorDetail:
      type: object
      required:
        - code
        - message
        - timestamp
      properties:
        code:
          type: string
          description: Machine-readable error code.
          example: RESOURCE_NOT_FOUND
        message:
          type: string
          description: Human-readable explanation.
          example: Composition not found
        param:
          type: string
          description: The field that caused the error, when one did.
          example: name
        docUrl:
          type: string
          description: Where this error is explained.
        suggestedAction:
          type: string
          description: What to do about it.
        retryAfter:
          type: integer
          description: >-
            Seconds to wait before trying again (rate limits). The same number
            is in the `Retry-After` header.
          example: 60
        details:
          type: object
          additionalProperties: true
          description: >-
            More about the error: the fields that failed, a limit that was
            reached.
        correlationId:
          type: string
          description: Quote this when you ask support about the call.
          example: req_123e4567-e89b-12d3-a456-426614174000
        timestamp:
          type: string
          format: date-time
          example: '2026-10-15T10:00:00.000Z'
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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