Metadata

Read-only tenant settings, reference data, plans, roles, themes, languages, and feature settings.

Metadata methods are read-only helpers for dropdowns, tenant configuration, and feature detection. Most records include a stable id or machine-readable value when Linxio supplies one, plus tenant-specific fields.

metadata.countries()

GET

List countries

/country/listlinxio.metadata.countries()

Lists country options used by Linxio address and tenant forms.

Input

void

optional

countries() does not take parameters.

Returns

LinxioCountryMap | null

optional

Object keyed by country code, with country display names as values.

Show child fields

string

optional

Country display name keyed by an ISO-style country code such as AU.

LinxioError | null

optional

Typed SDK error when countries cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

metadata.roles()

GET

List user roles

/roleslinxio.metadata.roles()

Lists user roles available to the authenticated account.

Input

void

optional

roles() does not take parameters.

Returns

LinxioRole[] | null

optional

Role records, usually including id, name, and type when supplied.

LinxioError | null

optional

Typed SDK error when roles cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Roles

const roles = await linxio.metadata.roles();

if (roles.error) {
  throw roles.error;
}

const driverRole = roles.data.find((role) => role.name === "Driver");

Example response


{
  "data": [
    "string"
  ],
  "error": null
}

metadata.plans()

GET

List plans

/planslinxio.metadata.plans()

Lists plan definitions visible to the authenticated account.

Input

void

optional

plans() does not take parameters.

Returns

LinxioPlan[] | null

optional

Plan records.

LinxioError | null

optional

Typed SDK error when plans cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

metadata.timezones()

GET

List timezones

/timezoneslinxio.metadata.timezones()

Lists timezone options used by Linxio tenant and user settings.

Input

void

optional

timezones() does not take parameters.

Returns

LinxioTimezone[] | null

optional

Timezone records, usually including name and offset when supplied.

LinxioError | null

optional

Typed SDK error when timezones cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

metadata.themes()

GET

List dashboard themes

/themeslinxio.metadata.themes()

Lists dashboard theme definitions.

Input

void

optional

themes() does not take parameters.

Returns

LinxioTheme[] | null

optional

Theme records.

LinxioError | null

optional

Typed SDK error when themes cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

metadata.myTheme()

GET

Get current dashboard theme

/themes/mylinxio.metadata.myTheme()

Fetches the current user's active dashboard theme.

Input

void

optional

myTheme() does not take parameters.

Returns

LinxioTheme | null

optional

Current theme record.

LinxioError | null

optional

Typed SDK error when the current theme cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

metadata.currentPlan()

GET

Get current plan permissions

/permissions/current-planlinxio.metadata.currentPlan()

Fetches current-plan permission keys for the authenticated tenant.

Input

void

optional

currentPlan() does not take parameters.

Returns

LinxioCurrentPlan | null

optional

Enabled permission or feature keys.

Show child fields

string

optional

Permission or feature key enabled for the current plan.

LinxioError | null

optional

Typed SDK error when current plan data cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

metadata.platformDomain()

GET

Get platform domain settings

/platform-settings/domainlinxio.metadata.platformDomain()

Fetches hosted-domain settings for the current platform.

Input

void

optional

platformDomain() does not take parameters.

Returns

LinxioPlatformDomain | null

optional

Platform domain settings.

LinxioError | null

optional

Typed SDK error when platform domain settings cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

metadata.languages()

GET

List languages

/settings/language/listlinxio.metadata.languages()

Lists language options used by Linxio settings screens.

Input

void

optional

languages() does not take parameters.

Returns

LinxioLanguage[] | null

optional

Language records, usually including code and name.

LinxioError | null

optional

Typed SDK error when languages cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

metadata.mapApiOptions()

GET

List map API options

/settings/mapApiOptionslinxio.metadata.mapApiOptions()

Fetches the map API option setting record for the current tenant.

Input

void

optional

mapApiOptions() does not take parameters.

Returns

LinxioMapApiOption | null

optional

Setting record including id, name, value, role, team, and user when supplied.

LinxioError | null

optional

Typed SDK error when map options cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

metadata.providers()

GET

Get provider settings

/settings/providerlinxio.metadata.providers()

Fetches dashboard provider settings visible to the current account.

Input

void

optional

providers() does not take parameters.

Returns

LinxioProviderSetting | null

optional

Setting record including id, name, value, role, team, and user when supplied.

LinxioError | null

optional

Typed SDK error when provider settings cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

metadata.digitalFormSettings()

GET

Get digital form settings

/settings/digitalFormlinxio.metadata.digitalFormSettings()

Fetches tenant-level digital-form settings.

Input

void

optional

digitalFormSettings() does not take parameters.

Returns

LinxioDigitalFormSettings | null

optional

Setting record including id, name, value, role, team, and user when supplied.

LinxioError | null

optional

Typed SDK error when settings cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

metadata.ecoSpeedSettings()

GET

Get eco-speed settings

/settings/ecoSpeedlinxio.metadata.ecoSpeedSettings()

Fetches tenant-level eco-speed settings.

Input

void

optional

ecoSpeedSettings() does not take parameters.

Returns

LinxioEcoSpeedSettings | null

optional

Setting record including id, name, value, role, team, and user when supplied.

LinxioError | null

optional

Typed SDK error when settings cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

metadata.excessiveIdlingSettings()

GET

Get excessive-idling settings

/settings/excessiveIdlinglinxio.metadata.excessiveIdlingSettings()

Fetches tenant-level excessive-idling settings.

Input

void

optional

excessiveIdlingSettings() does not take parameters.

Returns

LinxioExcessiveIdlingSettings | null

optional

Setting record including id, name, value, role, team, and user when supplied.

LinxioError | null

optional

Typed SDK error when settings cannot be loaded.

Show child fields

string

required

Safe error message.

string

required

SDK error class name.

unknown

optional

Original cause when available.

string

optional

HTTP method when the error came from a request.

string

optional

API path when the error came from a request.

string

optional

Request identifier from X-Request-Id when supplied.

Metadata

List countries

Input

Returns

List user roles

Input

Returns

List plans

Input

Returns

List timezones

Input

Returns

List dashboard themes

Input

Returns

Get current dashboard theme

Input

Returns

Get current plan permissions

Input

Returns

Get platform domain settings

Input

Returns

List languages

Input

Returns

List map API options

Input

Returns

Get provider settings

Input

Returns

Get digital form settings

Input

Returns

Get eco-speed settings

Input

Returns

Get excessive-idling settings

Input

Returns

On this page