Pular para o conteúdo principal
GET
Obter usuário interno por um identificador

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

type
enum<string>
obrigatório

Tipo de identificador usado para informar o valor. O celular de um usuário interno não é uma opção.

Opções disponíveis:
ID,
EMAIL
value
string
obrigatório

O identificador no formato indicado por type. Em um EMAIL, o domínio é convertido para minúsculas, mas a parte local deve corresponder exatamente ao valor enviado.

Required string length: 1 - 320

Resposta

Resposta bem-sucedida

Corpo da resposta para operações de leitura de usuários internos (agentes humanos).

id
string
obrigatório

Identificador único do usuário interno (UUID v4).

Exemplo:

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

status
enum<string>
obrigatório

'active' quando o usuário interno está ativo; 'disabled' quando o usuário foi removido.

Opções disponíveis:
active,
disabled
Exemplos:

"active"

"disabled"

createdAt
string
obrigatório

Data e hora de criação do usuário interno.

Exemplo:

"2003-04-10T08:00:00.000Z"

updatedAt
string
obrigatório

Data e hora da última atualização do usuário interno.

Exemplo:

"2003-04-10T08:00:00.000Z"

firstName
string | null

Nome do usuário interno.

Exemplo:

"John"

lastName
string | null

Sobrenome do usuário interno.

Exemplo:

"Doe"

email
string | null

E-mail do usuário interno.

Exemplo:

"john.doe@example.com"

cellphone
string | null

Número de celular do usuário interno.

Exemplo:

"+14084029292"

languageCode
enum<string> | null

Código de idioma do usuário interno.

Opções disponíveis:
ES,
EN,
AF,
SQ,
AR,
AZ,
BN,
BG,
CA,
ZH_CN,
HR,
CS,
DA,
NL,
ET,
FIL,
FI,
FR,
KA,
DE,
EL,
GU,
HA,
HE,
HI,
HU,
ID,
GA,
IT,
JA,
KN,
KK,
RW_RW,
KO,
KY_KG,
LO,
LV,
LT,
MK,
MS,
ML,
MR,
NB,
FA,
PL,
PT_BR,
PA,
RO,
RU,
SR,
SK,
SL,
SW,
SV,
TA,
TE,
TH,
TR,
UK,
UR,
UZ,
VI,
ZU
Exemplo:

"EN"