> ## 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 external users > List end users for your project with optional channel/source filters, pagination, sorting, and credit usage totals. ## OpenAPI ````yaml /api-reference/openapi.json get /api/v1/external-users 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. Only endpoints that support API Key authentication via the @ApiKeyEnabled() decorator. Send x-api-key (required). On multi-tenant endpoints, optionally send x-username (defaults to the project’s default 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 paths: /api/v1/external-users: get: tags: - External Users summary: List external users description: >- List end users for your project with optional channel/source filters, pagination, sorting, and credit usage totals. operationId: ExternalUsersController_list parameters: - name: q required: false in: query description: Filter by username (name) with case-insensitive partial match schema: maxLength: 255 type: string - name: channel required: false in: query description: Filter by messaging channel (metadata.channel, e.g. telegram) schema: maxLength: 64 type: string - name: source required: false in: query description: Filter by external user source schema: enum: - project_default - username - embed_visitor - trigger_thread type: string - name: isActive required: false in: query description: Filter by active status (omit for all) schema: type: boolean - name: activeEuid required: false in: query description: >- Pin this external user id to the top of the list (current dashboard selection) schema: type: string - name: sortBy required: false in: query description: Field to sort by (after pin ranking) schema: enum: - name - createdAt - source - creditsUsed - isActive - id - channel - profileSummary - lastSeenAt - agentCount - workflowCount - knowledgeStorageKb - databaseStorageKb - storageUsedKb - connectionCount type: string - name: sortOrder required: false in: query description: Sort order schema: default: ASC enum: - ASC - DESC type: string - name: from required: false in: query description: Credits sum from date (ISO 8601) schema: type: string - name: to required: false in: query description: Credits sum to date (ISO 8601) schema: type: string - name: page required: false in: query schema: minimum: 1 default: 1 type: number - name: limit required: false in: query schema: minimum: 1 maximum: 100 default: 20 type: number - 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: External users retrieved successfully content: application/json: schema: $ref: '#/components/schemas/PaginatedResponseDto' security: - x-api-key: [] - x-api-key: [] x-username: [] components: schemas: PaginatedResponseDto: $ref: '#/components/schemas/PaginatedResponseDto' type: object properties: success: type: boolean description: Success status example: true message: type: string description: Response message example: Data retrieved successfully data: type: array description: Array of items total: type: number description: Total number of items across all pages example: 100 totalTools: type: number description: >- Optional secondary total (e.g. nested tools across all matching toolkits) example: 5000 page: type: number description: Current page number (1-based) example: 1 limit: type: number description: Number of items per page example: 20 totalPages: type: number description: Total number of pages example: 5 hasNextPage: type: boolean description: Whether there is a next page example: true hasPreviousPage: type: boolean description: Whether there is a previous page example: false required: - success - message - data - total 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: 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: ````