linxio-js
API Reference

Metadata

Read-only reference data and tenant settings endpoints.

Metadata endpoints return dropdown options, tenant settings, and feature flags. Most shapes are tenant-configurable, so the SDK preserves unknown fields.

Service Surface
Reference data
GET /country/listGET /rolesGET /plansGET /timezonesGET /themesGET /themes/my
Tenant settings
GET /permissions/current-planGET /platform-settings/domainGET /settings/language/listGET /settings/mapApiOptionsGET /settings/provider
Feature settings
GET /settings/digitalFormGET /settings/ecoSpeedGET /settings/excessiveIdling

GET /country/list

GET

List countries

/country/listlinxio.metadata.countries()

Lists country options.

Request headers

Bearer token
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response body fields

string
optional
Country display name keyed by country code.

GET /roles

GET

List user roles

/roleslinxio.metadata.roles()

Lists user roles available to the authenticated account.

Request headers

Bearer token
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response body fields

LinxioId
optional
Role identifier.
string
optional
Role display name.
string
optional
Role scope when supplied.

GET /plans

GET

List plans

/planslinxio.metadata.plans()

Lists plan definitions visible to the account.

Request headers

Bearer token
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response body fields

LinxioId
optional
Plan identifier when supplied.
string
optional
Plan display name.

GET /timezones

GET

List timezones

/timezoneslinxio.metadata.timezones()

Lists timezone options.

Request headers

Bearer token
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response body fields

string
optional
Timezone name or value.
string
optional
UTC offset label when supplied.

GET /themes

GET

List dashboard themes

/themeslinxio.metadata.themes()

Lists dashboard theme definitions.

Request headers

Bearer token
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response body fields

LinxioId
optional
Theme identifier when supplied.
string
optional
Theme display name.

GET /themes/my

GET

Get current dashboard theme

/themes/mylinxio.metadata.myTheme()

Returns the current user's active dashboard theme.

Request headers

Bearer token
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response body fields

LinxioId
optional
Theme identifier when supplied.
string
optional
Theme display name.

GET /permissions/current-plan

GET

Get current plan permissions

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

Returns current-plan permission keys for the authenticated tenant.

Request headers

Bearer token
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response body fields

string
optional
Enabled permission or feature key.

GET /platform-settings/domain

GET

Get platform domain settings

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

Returns hosted-domain settings for the current platform.

Request headers

Bearer token
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response body fields

string
optional
Tenant domain when supplied.
string
optional
Hostname when supplied.

GET /settings/language/list

GET

List languages

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

Lists language options.

Request headers

Bearer token
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response body fields

string
optional
Locale or language code.
string
optional
Language display name.

GET /settings/mapApiOptions

GET

Get map API options

/settings/mapApiOptionslinxio.metadata.mapApiOptions()

Returns the map API option setting record.

Request headers

Bearer token
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response body fields

LinxioId
optional
Setting identifier.
string
optional
Setting name.
unknown
optional
Tenant-specific setting value.
unknown
optional
Role scope when supplied.
unknown
optional
Team scope when supplied.
unknown
optional
User scope when supplied.

GET /settings/provider

GET

Get provider settings

/settings/providerlinxio.metadata.providers()

Returns dashboard provider settings visible to the account.

Request headers

Bearer token
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response body fields

LinxioId
optional
Setting identifier.
string
optional
Setting name.
unknown
optional
Tenant-specific provider value.
unknown
optional
Role scope when supplied.
unknown
optional
Team scope when supplied.
unknown
optional
User scope when supplied.

GET /settings/digitalForm

GET

Get digital form settings

/settings/digitalFormlinxio.metadata.digitalFormSettings()

Returns tenant-level digital-form settings.

Request headers

Bearer token
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response body fields

LinxioId
optional
Setting identifier.
string
optional
Setting name.
unknown
optional
Tenant-specific digital-form value.
unknown
optional
Optional setting scope fields.

GET /settings/ecoSpeed

GET

Get eco-speed settings

/settings/ecoSpeedlinxio.metadata.ecoSpeedSettings()

Returns tenant-level eco-speed settings.

Request headers

Bearer token
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response body fields

LinxioId
optional
Setting identifier.
string
optional
Setting name.
unknown
optional
Tenant-specific eco-speed value.
unknown
optional
Optional setting scope fields.

GET /settings/excessiveIdling

GET

Get excessive-idling settings

/settings/excessiveIdlinglinxio.metadata.excessiveIdlingSettings()

Returns tenant-level excessive-idling settings.

Request headers

Bearer token
required
JWT bearer token returned by login or token refresh.

Request query parameters

void
optional
No query parameters are required.

Response body fields

LinxioId
optional
Setting identifier.
string
optional
Setting name.
unknown
optional
Tenant-specific excessive-idling value.
unknown
optional
Optional setting scope fields.

On this page