Skip to the content

Texa DeskDevelopers

Section

Platform API · Accounts

Get an account details

GET/platform/api/v1/accounts/{account_id}

Get the details of an account

Authorization

api_access_tokenheaderrequired

A platform app's token. Platform apps exist only on a dedicated instance, made in its super admin console. On Texa's shared hosting this API is not open to companies.

Path parameters

account_idintegerrequired

The numeric ID of the account

Responses

200

Success

idnumber

Account ID

namestring

Name of the account

401

Unauthorized

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

404

The given account does not exist

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

curl 'https://desk.texadesk.com/platform/api/v1/accounts/1' \
  -H "api_access_token: $PLATFORM_TOKEN"

import os, requests

headers = {"api_access_token": os.environ["PLATFORM_TOKEN"]}
r = requests.get("https://desk.texadesk.com/platform/api/v1/accounts/1", headers=headers)
r.raise_for_status()
print(r.json())

const r = await fetch("https://desk.texadesk.com/platform/api/v1/accounts/1", {
  method: "GET",
  headers: { "api_access_token": `${process.env.PLATFORM_TOKEN}` },
});
if (!r.ok) throw new Error(`${r.status}: ${await r.text()}`);
console.log(await r.json());

Response 200

{
  "id": 1.0,
  "name": "string"
}