Account API

Available Endpoints

Endpoints

GET/api/v1/account

PUT/api/v1/account

The Account Object

company_name string

Company name associated with the account

custom_domain string

Custom domain for the account

data object

Additional account data

groups array

Permission groups for the account

id string

System-generated unique identifier

level integer

Account level or tier

object string

Object type identifier

theme string

Theme setting for the account

time_zone string

Time zone setting for the account in IANA timezone format (e.g. 'America/New_York', 'Europe/London', 'Asia/Tokyo', 'Etc/UTC')

user_name string

User name from context

data_schema array

Account data schema

user_data_schema array

User data schema for the account

Account Object

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "company_name": null,
  "custom_domain": null,
  "data": {},
  "data_schema": [],
  "groups": [],
  "id": "0198c2e9-a81b-7e17-bd55-7efb37cbf209",
  "level": 0,
  "object": "account",
  "theme": null,
  "time_zone": "America/New_York",
  "user_data_schema": [],
  "user_name": null
}