Pular para o conteúdo principal
GET
/
api
/
v1
/
accounts
/
{account_id}
Obter detalhes da conta
curl --request GET \
  --url https://airys.chat/api/v1/accounts/{account_id} \
  --header 'api_access_token: <api-key>'
import requests

url = "https://airys.chat/api/v1/accounts/{account_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/api/v1/accounts/{account_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/api/v1/accounts/{account_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/api/v1/accounts/{account_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/api/v1/accounts/{account_id}")
.header("api_access_token", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://airys.chat/api/v1/accounts/{account_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,
  "name": "<string>",
  "locale": "<string>",
  "domain": "<string>",
  "support_email": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "cache_keys": {},
  "features": {},
  "settings": {
    "auto_resolve_after": 123,
    "auto_resolve_message": "<string>",
    "auto_resolve_ignore_waiting": true
  },
  "custom_attributes": {
    "plan_name": "<string>",
    "subscribed_quantity": 123,
    "subscription_status": "<string>",
    "subscription_ends_on": "2023-12-25",
    "industry": "<string>",
    "company_size": "<string>",
    "timezone": "<string>",
    "logo": "<string>",
    "onboarding_step": "<string>",
    "marked_for_deletion_at": "2023-11-07T05:31:56Z",
    "marked_for_deletion_reason": "<string>"
  },
  "latest_chatwoot_version": "3.0.0",
  "subscribed_features": [
    "<string>"
  ]
}
{
"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 visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário.

Parâmetros de caminho

account_id
integer
obrigatório

O ID numérico da conta

Resposta

Sucesso

id
number

ID da conta

name
string

Nome da conta

locale
string

A localidade (locale) da conta

domain
string

O domínio da conta

support_email
string

O e-mail de suporte da conta

status
string

O status da conta

created_at
string<date-time>

A data de criação da conta

cache_keys
object

Chaves de cache (cache keys) para a conta

features
object

Recursos ativados para a conta

settings
object

Configurações da conta

custom_attributes
object

Atributos personalizados da conta

latest_chatwoot_version
string | null

Versão mais recente do Chatwoot disponível

Exemplo:

"3.0.0"

subscribed_features
string[]

Lista de recursos corporativos assinados (se a edição Enterprise estiver habilitada)