Pular para o conteúdo principal
GET
/
platform
/
api
/
v1
/
users
/
{id}
Obter an user detalhes
curl --request GET \
  --url https://airys.chat/platform/api/v1/users/{id} \
  --header 'api_access_token: <api-key>'
import requests

url = "https://airys.chat/platform/api/v1/users/{id}"

headers = {"api_access_token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};

fetch('https://airys.chat/platform/api/v1/users/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://airys.chat/platform/api/v1/users/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_access_token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://airys.chat/platform/api/v1/users/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_access_token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://airys.chat/platform/api/v1/users/{id}")
  .header("api_access_token", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://airys.chat/platform/api/v1/users/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "access_token": "<string>",
  "account_id": 123,
  "available_name": "<string>",
  "avatar_url": "<string>",
  "confirmed": true,
  "display_name": "<string>",
  "message_signature": "<string>",
  "email": "<string>",
  "hmac_identifier": "<string>",
  "inviter_id": 123,
  "name": "<string>",
  "provider": "<string>",
  "pubsub_token": "<string>",
  "ui_settings": {},
  "uid": "<string>",
  "type": "<string>",
  "custom_attributes": {},
  "accounts": [
    {
      "id": 123,
      "name": "<string>",
      "status": "<string>",
      "active_at": "2023-11-07T05:31:56Z",
      "permissions": [
        "<string>"
      ],
      "availability": "<string>",
      "availability_status": "<string>",
      "auto_offline": true,
      "custom_role_id": 123,
      "custom_role": {}
    }
  ]
}
{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}
{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Autorizações

api_access_token
string
header
obrigatório

Este token pode ser obtido pelo administrador do sistema após a criação de um platformApp. Este token deve ser usado para provisionar bot de agentes, contas, usuários e suas funções.

Parâmetros de caminho

id
integer
obrigatório

O ID numérico do usuário na plataforma

Resposta

Sucesso

id
number
access_token
string
account_id
number
available_name
string
avatar_url
string
confirmed
boolean
display_name
string | null
message_signature
string | null
email
string
hmac_identifier
string
inviter_id
number | null
name
string
provider
string
pubsub_token
string
role
enum<string>
Opções disponíveis:
agent,
administrator
ui_settings
object
uid
string
type
string | null
custom_attributes
object

Disponível para usuários criados por meio das APIs da plataforma e que possuem atributos personalizados associados.

accounts
object[]