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
Example:

"alice"

channel
string

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

Maximum string length: 64
Example:

"telegram"

source
enum<string>[]

Filter by source. One value, comma-separated, or repeated query params.

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

Filter by active status (omit for all)

Example:

true

activeEuid
string

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

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

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)

Example:

"2026-08-01T00:00:00.000Z"

to
string

Credits sum to date (ISO 8601)

Example:

"2026-09-01T00:00:00.000Z"

page
number
default:1

Page number (1-based)

Required range: x >= 1
Example:

1

limit
number
default:20

Number of items per page (max 100)

Required range: 1 <= x <= 100
Example:

20

Response

200 - application/json

External users retrieved successfully

success
boolean
required

Success status

Example:

true

message
string
required

Response message

Example:

"Data retrieved successfully"

data
object[]
required

Array of items

Example:
total
number
required

Total number of items across all pages

Example:

100

totalTools
number

Optional secondary total (e.g. nested tools across all matching toolkits)

Example:

5000

page
number

Current page number (1-based)

Example:

1

limit
number

Number of items per page

Example:

20

totalPages
number

Total number of pages

Example:

5

hasNextPage
boolean

Whether there is a next page

Example:

true

hasPreviousPage
boolean

Whether there is a previous page

Example:

false