List external users
List end users for your project with optional channel/source filters, pagination, sorting, and credit usage totals.
Authorizations
Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:
Headers
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.
Query Parameters
Filter by username (name) with case-insensitive partial match
255Filter by messaging channel (metadata.channel, e.g. telegram)
64Filter by external user source
project_default, username, embed_visitor, trigger_thread Filter by active status (omit for all)
Pin this external user id to the top of the list (current dashboard selection)
Field to sort by (after pin ranking)
name, createdAt, source, creditsUsed, isActive, id, channel, profileSummary, lastSeenAt, agentCount, workflowCount, knowledgeStorageKb, databaseStorageKb, storageUsedKb, connectionCount Sort order
ASC, DESC Credits sum from date (ISO 8601)
Credits sum to date (ISO 8601)
x >= 11 <= x <= 100Response
External users retrieved successfully