Skip to main content
GET

Authorizations

x-api-key
string
header
required

API key used to authenticate and authorise every request. Include it in the x-api-key header.

Headers

Accept
enum<string>
required

Defines the response type.

Available options:
application/vnd.Creative Force.v2.3+json,
application/vnd.Creative Force.v2.3+xml
x-api-language
enum<string>[]

Defines the languages included in the response. If non are provided, the account default language is returned.

Value all overrides any other values present.

You can request multiple languages using a comma-separated string of languages.

The selected language must be supported by your account or a 400 error is returned.

Available options:
all,
ar_AR,
bg_BG,
bn_IN,
ca_ES,
cs_CZ,
cy_GB,
da_DK,
de_DE,
en_GB,
en_US,
el_GR,
es_NN,
es_LA,
et_EE,
fa_NN,
fi_FI,
fr_FR,
fr_CA,
he_IL,
hi_IN,
hr_HR,
hu_HU,
hy_AM,
it_IT,
ja_JP,
ko_KR,
lt_LT,
ms_MY,
nl_NL,
nb_NO,
pl_PL,
pt_BR,
ro_RO,
ru_RU,
sk_SK,
sl_SI,
sq_AL,
sr_RS,
sv_SE,
sw_NN,
th_TH,
tr_TR,
uk_UA,
vi_VN,
zh_CN,
zh_HK

Response

Account retrieved.

Tenant-level account record describing the subscription and configuration shared by every resource within it.

Each account has one owner, one product tier, a region, a timezone, and a set of enabled locales. The locale codes here are the keys used by translation maps elsewhere in the API (such as category, chapter, round, and score-set names).

created
string<date-time>

Time the account was created.

domains
string[]

Hostnames associated with the account.

Includes the primary public domain and any staging or local mirrors configured for the account.

global_id
string<uuid>

Globally unique identifier for the account.

Stable across slug changes and consistent across the platform.

languages
object[]

Locales enabled for the account.

Translation maps on other resources (such as category, round, and score-set names) are keyed by these codes.

name
string

Display name of the account.

owner
object

User who owns the account.

product
string

Subscription plan tier the account is on.

Resolved from the underlying plan code, for example Premium.

region
string

Deployment region the account is hosted in.

Two-letter region code, for example au or eu.

slug
string

Short URL-safe identifier for the account.

timezone
string

Timezone the account uses for date calculations.

Returned as a concatenated IANA identifier without the slash separator, for example EuropeLondon.

updated
string<date-time>

Time the account record was last updated.