Pular para o conteúdo principal
GET
Listar usuários internos

Autorizações

x-api-key
string
header
obrigatório

Copy the API key as provided by the Bridge Console.

Parâmetros de caminho

workspaceId
string<uuid>
obrigatório

Identificador único do workspace (UUID v4).

Exemplo:

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

Parâmetros de consulta

email
string | null

Filtra usuários internos pelo e-mail exato. Obsoleto: será removido. Use GET /users/lookup?type=EMAIL. Consulte o histórico de alterações. Filtrar usuários internos pelo e-mail exato.

Exemplo:

"john.doe@example.com"

status
enum<string>
padrão:active

Filtra por status: 'active' (padrão), 'disabled' ou 'all'. Obsoleto: será removido. Leia status em cada linha. Consulte o histórico de alterações. Filtrar por status: 'active' (padrão), 'disabled' ou 'all'.

Opções disponíveis:
active,
disabled,
all
limit
integer
padrão:20

Número de usuários internos por página

Intervalo obrigatório: 1 <= x <= 100
cursor
string | null

Cursor recebido em uma solicitação anterior para obter a próxima página

Resposta

Resposta bem-sucedida

Corpo da resposta para listar usuários internos.

users
InternalUserResponse · object[]
obrigatório

Lista de usuários internos.

cursor
string | null

Cursor a ser enviado ao solicitar a próxima página.