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

# List a user's connections

> Only connections your own grants cover, even if another consumer shares the account.



## OpenAPI

````yaml /api-docs/connect/openapi-connect.json get /connections
openapi: 3.1.0
info:
  title: NOX Connections API
  version: 1.0.0
  description: >-
    Connect a user's account at a provider (a device brand or a utility) to NOX
    Energy, and manage that access.
servers:
  - url: https://api.connect.nox.energy/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: Connections
    description: Creating, listing and revoking connections.
  - name: Households
    description: The dwelling a person's connections belong to.
paths:
  /connections:
    get:
      tags:
        - Connections
      summary: List a user's connections
      description: >-
        Only connections your own grants cover, even if another consumer shares
        the account.
      parameters:
        - name: user_id
          in: query
          required: true
          description: Your internal user ID.
          schema:
            type: string
        - name: provider
          in: query
          required: false
          description: Limit to one provider.
          schema:
            type: string
      responses:
        '200':
          description: The user's connections; empty when there are none.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionsResponse'
        '400':
          description: >-
            The request was rejected; `error` says which field, rule or
            provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or unknown API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: A bug on our side; `code` is `unexpected`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    ConnectionsResponse:
      additionalProperties: false
      properties:
        connections:
          items:
            $ref: '#/components/schemas/Connection'
          title: Connections
          type: array
      required:
        - connections
      title: ConnectionsResponse
      type: object
    Error:
      type: object
      properties:
        error:
          type: string
          description: What went wrong, in full.
        code:
          $ref: '#/components/schemas/ConnectFailureCode'
          description: >-
            Present when the failure has one: the same closed set the connect UI
            translates.
      required:
        - error
    Connection:
      additionalProperties: false
      properties:
        connection_id:
          title: Connection Id
          type: string
        consumer_user_id:
          title: Consumer User Id
          type: string
        provider:
          title: Provider
          type: string
        credential_type:
          $ref: '#/components/schemas/CredentialType'
        device_ids:
          items:
            type: string
          title: Device Ids
          type: array
        needs_reauth:
          title: Needs Reauth
          type: boolean
        connected_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Connected At
      required:
        - connection_id
        - consumer_user_id
        - provider
        - credential_type
        - device_ids
        - needs_reauth
        - connected_at
      title: Connection
      type: object
    ConnectFailureCode:
      description: Ported from what the legacy authenticator-api tells users.
      enum:
        - no_devices
        - unsupported_device
        - invalid_credentials
        - unsupported_country
        - not_account_owner
        - multiple_users
        - missing_site_id
        - invalid_ean
        - invalid_site_id
        - onboarding_failed
        - registration_failed
        - missing_permissions
        - hybrid_inverter_not_allowed
        - session_not_found
        - session_expired
        - authorization_spent
        - provider_unavailable
        - rate_limited
        - invalid_request
        - unexpected
      title: ConnectFailureCode
      type: string
    CredentialType:
      enum:
        - oauth
        - app_credentials
        - manufacturer_identifier
        - ean
      title: CredentialType
      type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your consumer API key.

````

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