Flowra Users API

openapi: 3.2.0
info:
  title: Flowra API (API Key Endpoints) Users API
  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
tags:
- name: Users
  description: User profile
paths:
  /api/v1/users/profile:
    get:
      operationId: UsersController_getProfile
      x-apiKeyEnabled: true
      summary: Get current user profile
      description: Returns the profile of the authenticated user (dashboard account). Prefer the x-api-key header for API access; JWT Bearer also works for the dashboard session.
      responses:
        '200':
          description: User profile retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResponseDtoSuccessResponse'
              example:
                success: true
                message: Operation completed successfully
                data:
                  id: uuid
                  email: user@example.com
                  firstName: John
                  lastName: Doe
                  googleId: '123456789'
                  githubId: '123456789'
                  roles:
                  - admin
                  - Supplier
                  hasPassword: true
                  isActive: true
      tags:
      - Users
      security:
      - x-api-key: []
components:
  schemas:
    ProfileResponseDtoSuccessResponse:
      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:
            id:
              type: string
              description: User ID
              example: uuid
            email:
              type: string
              description: User email address
              example: user@example.com
            firstName:
              type: string
              description: User first name
              example: John
            lastName:
              type: string
              description: User last name
              example: Doe
            googleId:
              type: string
              description: Google ID if user logged in with Google
              example: '123456789'
            githubId:
              type: string
              description: GitHub ID if user logged in with GitHub
              example: '123456789'
            roles:
              description: User roles
              example:
              - admin
              - Supplier
              type: array
              items:
                type: string
            hasPassword:
              type: boolean
              description: Whether user has password set
              example: true
            isActive:
              type: boolean
              description: Whether user is active
              example: true
          required:
          - id
          - email
          - roles
          - hasPassword
          - isActive
          example:
            id: uuid
            email: user@example.com
            firstName: John
            lastName: Doe
            googleId: '123456789'
            githubId: '123456789'
            roles:
            - admin
            - Supplier
            hasPassword: true
            isActive: true
      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>'