Skip to main content
GET
List external users

Authorizations

x-api-key
string
header
required

Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:

Headers

x-username
string
default:(project default user)

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

q
string

Filter by username (name) with case-insensitive partial match

Maximum string length: 255
channel
string

Filter by messaging channel (metadata.channel, e.g. telegram)

Maximum string length: 64
source
enum<string>

Filter by external user source

Available options:
project_default,
username,
embed_visitor,
trigger_thread
isActive
boolean

Filter by active status (omit for all)

activeEuid
string

Pin this external user id to the top of the list (current dashboard selection)

sortBy
enum<string>

Field to sort by (after pin ranking)

Available options:
name,
createdAt,
source,
creditsUsed,
isActive,
id,
channel,
profileSummary,
lastSeenAt,
agentCount,
workflowCount,
knowledgeStorageKb,
databaseStorageKb,
storageUsedKb,
connectionCount
sortOrder
enum<string>
default:ASC

Sort order

Available options:
ASC,
DESC
from
string

Credits sum from date (ISO 8601)

to
string

Credits sum to date (ISO 8601)

page
number
default:1
Required range: x >= 1
limit
number
default:20
Required range: 1 <= x <= 100

Response

200 - application/json

External users retrieved successfully