Pular para o conteúdo principal

Listar agentes

GET [Url Ambiente]/api/Agent/List

Esse endpoint é utilizado para listar todos os agentes disponíveis no sistema para a sua empresa.

IdentificadorValor
Acceptapplication/json
AuthorizationToken de autenticação

Status code 200

ParâmetroDescriçãoTipoExemplos
Agents[].IdIdentificador do agenteInt1
Agents[].Defaultagente padrão para todas as empresasbooltrue
Agents[].NameNome do agenteString"Eduardo"
Agents[].CreatedAtData de criação do agenteDateTime"1990-01-01T00:00:00Z"

Exemplo

{
"Agents": [
{
"Id": 0,
"Default": true,
"Name": "Eduardo",
"CreatedAt": "1990-01-01T00:00:00Z"
}
]
}

Exemplo CURL

curl -X GET \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {seu token}'
'https://api.skia.com.br/api/Agent/List'

Status Code 400

Erro na requisição

ParâmetroDescriçãoTipoExemplos
StatusStatus da requisiçãoOK = 0, ERROR = 11
MessagesDescrição dos errosString[]"Messages": []

Status Code 401

Não autorizado

ParâmetroDescriçãoTipoExemplos
StatusStatus da requisiçãoOK = 0, ERROR = 11
MessagesDescrição dos errosString[]"Messages": []

Exemplo

{
"Status": "1",
"Messages": [
"string"
]
}