Skip to main content
GET
List internal users with filtering and pagination

Authorizations

x-api-key
string
header
required

Copy the API key as provided by the Bridge Console.

Path Parameters

workspaceId
string<uuid>
required

Unique identifier of the workspace (UUID v4).

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

Query Parameters

email
string | null

Filter internal users by exact email address.

Example:

"john.doe@example.com"

status
enum<string>
default:active

Filter by status: 'active' (default), 'disabled', or 'all'.

Available options:
active,
disabled,
all
limit
integer
default:20

Number of internal users per page

Required range: 1 <= x <= 100
cursor
string | null

Cursor provided on a previous request to get the next page

Response

Successful Response

Response body for listing internal users.

users
InternalUserResponse · object[]
required

Array of internal users.

cursor
string | null

Cursor to be sent on the next page request.