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

# List connected accounts

> Returns all OAuth-connected accounts (e.g. Google, Slack) linked to your project. Use these when workflows or agents need to act on behalf of a connected user.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/connected_accounts
openapi: 3.0.0
info:
  title: Flowra API (API Key Endpoints)
  description: >-
    **Flowra** is an AI-powered platform for building agents, workflows, and
    integrations.


    ### Capabilities

    - **Tools & Toolkits** – Define and group tools for agents and workflows.

    - **Workflows** – Orchestrate steps and automate processes.

    - **Triggers** – Schedule or event-based execution.

    - **Auth & Connections** – OAuth, API keys, and connected accounts.

    - **MCP** – Model Context Protocol server integration.

    - **Knowledge / RAG** – Add files and URLs for retrieval-augmented
    generation.


    ### Authentication

    Use the **x-api-key** header with a project API key to access endpoints that
    support API Key auth. Create and manage API keys in the dashboard under your
    project settings.


    Only endpoints that support API Key authentication via the @ApiKeyEnabled()
    decorator.


    Send x-api-key (required). On multi-tenant endpoints, optionally send
    x-username to act as an external user.
  version: '1.0'
  contact:
    name: Flowra
    url: https://flowra.dev
servers:
  - url: https://flowra.dev
    description: Flowra API
security: []
tags:
  - name: Users
    description: User profile
  - name: External Users
    description: End-user identities inside a project (x-username)
  - name: Auth Configs
    description: OAuth and API key configs for toolkits
  - name: Connected Accounts
    description: OAuth connected accounts and link creation
  - name: Toolkits
    description: List and search toolkits
  - name: Tools
    description: List, execute, and manage tools
  - name: Skills
    description: Browse, create, import, and install skills
  - name: Workflow & Agent
    description: Create, run, and inspect workflows and agents
  - name: Triggers
    description: Schedule and event-based trigger instances
  - name: Chat
    description: Threads and streaming agent runs
  - name: File
    description: Upload, list, and download files
  - name: Knowledge
    description: RAG knowledge collections
  - name: Table
    description: Collections and documents
  - name: Sandbox
    description: Ephemeral and durable code sandboxes
  - name: Browser
    description: Live browser sessions and view
  - name: LLM
    description: List AI models and generate completions
  - name: MCP
    description: MCP server management
  - name: usage
    description: Credit balance and usage ledger for the project API key
paths:
  /api/v1/connected_accounts:
    get:
      tags:
        - Connected Accounts
      summary: List connected accounts
      description: >-
        Returns all OAuth-connected accounts (e.g. Google, Slack) linked to your
        project. Use these when workflows or agents need to act on behalf of a
        connected user.
      operationId: ConnectedAccountsController_getConnectedAccounts
      parameters:
        - name: toolkitSlugs
          required: false
          in: query
          description: The toolkit slugs of the connected accounts
          schema:
            example:
              - gmail
              - slack
            type: array
            items:
              type: string
        - name: statuses
          required: false
          in: query
          description: The status of the connected account
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ConnectedAccountStatus'
        - name: cursor
          required: false
          in: query
          description: The cursor to paginate through the connected accounts
          schema:
            example: eyJpZCI6IjNmYTg1ZjY0In0=
            type: string
        - name: limit
          required: false
          in: query
          description: The limit of the connected accounts to return
          schema:
            default: 10
            example: 10
            type: number
        - name: eUIDs
          required: false
          in: query
          description: The external user ids (eUID) of the connected accounts
          schema:
            example:
              - 3fa85f64-5717-4562-b3fc-2c963f66afa6
            type: array
            items:
              type: string
        - name: authConfigIds
          required: false
          in: query
          description: The auth config ids of the connected accounts
          schema:
            example:
              - auth_config_123
            type: array
            items:
              type: string
        - name: connectedAccountIds
          required: false
          in: query
          description: The connected account ids to filter by
          schema:
            example:
              - 7c9e6679-7425-40de-944b-e07fc1f90ae7
            type: array
            items:
              type: string
        - name: orderBy
          required: false
          in: query
          description: The order by of the connected accounts
          schema:
            enum:
              - createdAt
              - updatedAt
            type: string
        - name: orderDirection
          required: false
          in: query
          description: The order direction of the connected accounts
          schema:
            enum:
              - asc
              - desc
            type: string
        - name: labels
          required: false
          in: query
          description: The labels of the connected accounts
          schema:
            example:
              - work
            type: array
            items:
              type: string
        - name: x-username
          in: header
          required: false
          description: >-
            External user (end user) to act as. Optional — if omitted, Flowra
            uses the project’s default external user. Send a stable username
            (e.g. customer_alice) only when you need another end-user context.
          schema:
            type: string
            default: (project default user)
          example: customer_alice
      responses:
        '200':
          description: Successfully retrieved connected accounts
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetConnectedAccountsResponseDtoSuccessResponse
              example:
                success: true
                message: Operation completed successfully
                data:
                  items:
                    - toolkit:
                        slug: slack
                        name: Slack
                        logo: https://cdn.example.com/slack.png
                      authConfig:
                        id: auth_config_123
                        authScheme: OAUTH2
                        isProviderManaged: true
                        isDisabled: false
                        deprecated:
                          uuid: 123e4567-e89b-12d3-a456-426614174000
                      id: account_123
                      displayName: Work Slack
                      label: sara@company.com
                      eUID: 123e4567-e89b-12d3-a456-426614174000
                      status: ACTIVE
                      createdAt: '2023-01-01T00:00:00Z'
                      updatedAt: '2023-01-01T00:00:00Z'
                      state:
                        authScheme: OAUTH2
                        val: {}
                      statusReason: Connection successful
                      isDisabled: false
                      testRequestEndpoint: https://api.example.com/test
                      deprecated:
                        labels:
                          - production
                          - staging
                        uuid: 123e4567-e89b-12d3-a456-426614174000
                      data: {}
                      params: {}
                  nextCursor: eyJwYWdlIjoyLCJsaW1pdCI6MTB9
                  totalPages: 5
                  currentPage: 1
                  totalItems: 50
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '422':
          description: Unprocessable entity
        '500':
          description: Internal server error
      security:
        - x-api-key: []
        - x-api-key: []
          x-username: []
components:
  schemas:
    ConnectedAccountStatus:
      type: string
      enum:
        - INITIALIZING
        - INITIATED
        - ACTIVE
        - FAILED
        - EXPIRED
        - INACTIVE
    GetConnectedAccountsResponseDtoSuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Success status
          example: true
        message:
          type: string
          description: Success message
          example: Operation completed successfully
        data:
          type: object
          properties:
            items:
              description: List of connected accounts
              type: array
              items:
                type: object
                properties:
                  toolkit:
                    type: object
                    properties:
                      slug:
                        type: string
                        description: Toolkit slug
                        example: slack
                      name:
                        type: string
                        description: Display name from the toolkit record
                        example: Slack
                      logo:
                        type: string
                        nullable: true
                        description: Logo image URL from the toolkit record
                        example: https://cdn.example.com/slack.png
                    required:
                      - slug
                  authConfig:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Auth config ID
                        example: auth_config_123
                      authScheme:
                        enum:
                          - OAUTH1
                          - OAUTH2
                          - S2S_OAUTH2
                          - API_KEY
                          - BASIC
                          - BEARER_TOKEN
                          - BILLCOM_AUTH
                          - GOOGLE_SERVICE_ACCOUNT
                          - NO_AUTH
                          - BASIC_WITH_JWT
                          - CALCOM_AUTH
                          - SERVICE_ACCOUNT
                          - SAML
                          - DCR_OAUTH
                          - COOKIE
                          - WHATSAPP_QR
                        type: string
                        description: Authentication scheme
                        example: OAUTH2
                      isProviderManaged:
                        type: boolean
                        description: >-
                          Whether the auth is provider-managed (by Local or
                          Composio)
                        example: true
                      isDisabled:
                        type: boolean
                        description: Whether the auth config is disabled
                        example: false
                      deprecated:
                        type: object
                        description: Deprecated auth config info
                        properties:
                          uuid:
                            type: string
                            format: uuid
                            example: 123e4567-e89b-12d3-a456-426614174000
                    required:
                      - id
                      - authScheme
                      - isProviderManaged
                      - isDisabled
                      - deprecated
                  id:
                    type: string
                    description: Connected account ID
                    example: account_123
                  displayName:
                    type: string
                    nullable: true
                    description: Optional display name set in the dashboard
                    example: Work Slack
                  label:
                    type: string
                    description: >-
                      Human label: displayName, else provider identity
                      (email/username/shop), else toolkit name. Never a UUID.
                    example: sara@company.com
                  eUID:
                    type: string
                    description: External User ID (eUID)
                    example: 123e4567-e89b-12d3-a456-426614174000
                  status:
                    enum:
                      - INITIALIZING
                      - INITIATED
                      - ACTIVE
                      - FAILED
                      - EXPIRED
                      - INACTIVE
                    type: string
                    description: Account status
                    example: ACTIVE
                  createdAt:
                    type: string
                    description: Creation timestamp
                    example: '2023-01-01T00:00:00Z'
                  updatedAt:
                    type: string
                    description: Last update timestamp
                    example: '2023-01-01T00:00:00Z'
                  state:
                    type: object
                    properties:
                      authScheme:
                        enum:
                          - OAUTH1
                          - OAUTH2
                          - S2S_OAUTH2
                          - API_KEY
                          - BASIC
                          - BEARER_TOKEN
                          - BILLCOM_AUTH
                          - GOOGLE_SERVICE_ACCOUNT
                          - NO_AUTH
                          - BASIC_WITH_JWT
                          - CALCOM_AUTH
                          - SERVICE_ACCOUNT
                          - SAML
                          - DCR_OAUTH
                          - COOKIE
                          - WHATSAPP_QR
                        type: string
                        description: Authentication scheme
                        example: OAUTH2
                      val:
                        type: object
                        description: >-
                          State value - complex object with different structures
                          based on auth scheme
                        additionalProperties: true
                    required:
                      - authScheme
                      - val
                  statusReason:
                    type: string
                    description: Status reason
                    example: Connection successful
                  isDisabled:
                    type: boolean
                    description: Whether the account is disabled
                    example: false
                  testRequestEndpoint:
                    type: string
                    description: Test request endpoint
                    example: https://api.example.com/test
                  deprecated:
                    type: object
                    properties:
                      labels:
                        description: Labels associated with the connected account
                        example:
                          - production
                          - staging
                        type: array
                        items:
                          type: string
                      uuid:
                        type: string
                        description: UUID of the connected account
                        example: 123e4567-e89b-12d3-a456-426614174000
                    required:
                      - labels
                      - uuid
                  data:
                    type: object
                    nullable: true
                    description: >-
                      Provider-specific payload (e.g. Composio connected account
                      `data`)
                    additionalProperties: true
                  params:
                    type: object
                    nullable: true
                    description: Connection parameters (e.g. Composio `params`)
                    additionalProperties: true
                required:
                  - toolkit
                  - authConfig
                  - id
                  - label
                  - eUID
                  - status
                  - createdAt
                  - updatedAt
                  - state
                  - isDisabled
                  - deprecated
            nextCursor:
              type: string
              description: Next page cursor
              example: eyJwYWdlIjoyLCJsaW1pdCI6MTB9
            totalPages:
              type: number
              description: Total number of pages
              example: 5
            currentPage:
              type: number
              description: Current page number
              example: 1
            totalItems:
              type: number
              description: Total number of items
              example: 50
          required:
            - items
            - nextCursor
            - totalPages
            - currentPage
            - totalItems
          example:
            items:
              - toolkit:
                  slug: slack
                  name: Slack
                  logo: https://cdn.example.com/slack.png
                authConfig:
                  id: auth_config_123
                  authScheme: OAUTH2
                  isProviderManaged: true
                  isDisabled: false
                  deprecated:
                    uuid: 123e4567-e89b-12d3-a456-426614174000
                id: account_123
                displayName: Work Slack
                label: sara@company.com
                eUID: 123e4567-e89b-12d3-a456-426614174000
                status: ACTIVE
                createdAt: '2023-01-01T00:00:00Z'
                updatedAt: '2023-01-01T00:00:00Z'
                state:
                  authScheme: OAUTH2
                  val: {}
                statusReason: Connection successful
                isDisabled: false
                testRequestEndpoint: https://api.example.com/test
                deprecated:
                  labels:
                    - production
                    - staging
                  uuid: 123e4567-e89b-12d3-a456-426614174000
                data: {}
                params: {}
            nextCursor: eyJwYWdlIjoyLCJsaW1pdCI6MTB9
            totalPages: 5
            currentPage: 1
            totalItems: 50
      required:
        - success
        - message
        - data
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Project API key. Create and manage keys in the dashboard under Project →
        API Keys. Send as header: x-api-key: <your-key>
    x-username:
      type: apiKey
      in: header
      name: x-username
      description: >-
        Optional. External user username. If omitted, Flowra uses the project’s
        default external user. Send as header: x-username: <username>

````

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