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.

Query parameters

none
void
optional
No query parameters are required.

Response fields

code
string
optional
Country code when supplied.
name
string
optional
Country display name.

GET /roles

GET

List user roles

/roleslinxio.metadata.roles()

Lists user roles available to the authenticated account.

Query parameters

none
void
optional
No query parameters are required.

Response fields

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

GET /plans

GET

List plans

/planslinxio.metadata.plans()

Lists plan definitions visible to the account.

Query parameters

none
void
optional
No query parameters are required.

Response fields

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

GET /timezones

GET

List timezones

/timezoneslinxio.metadata.timezones()

Lists timezone options.

Query parameters

none
void
optional
No query parameters are required.

Response fields

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

GET /themes

GET

List dashboard themes

/themeslinxio.metadata.themes()

Lists dashboard theme definitions.

Query parameters

none
void
optional
No query parameters are required.

Response fields

id
LinxioId
optional
Theme identifier when supplied.
name
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.

Query parameters

none
void
optional
No query parameters are required.

Response fields

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

GET /permissions/current-plan

GET

Get current plan permissions

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

Returns current-plan permission and feature information.

Query parameters

none
void
optional
No query parameters are required.

Response fields

features
string[]
optional
Enabled feature keys when supplied.
permissions
object
optional
Permission flags keyed by feature or module.

GET /platform-settings/domain

GET

Get platform domain settings

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

Returns hosted-domain settings for the current platform.

Query parameters

none
void
optional
No query parameters are required.

Response fields

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

GET /settings/language/list

GET

List languages

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

Lists language options.

Query parameters

none
void
optional
No query parameters are required.

Response fields

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

GET /settings/mapApiOptions

GET

List map API options

/settings/mapApiOptionslinxio.metadata.mapApiOptions()

Lists map API provider options.

Query parameters

none
void
optional
No query parameters are required.

Response

data
LinxioMapApiOption[]
optional
Map API option records.

GET /settings/provider

GET

Get provider settings

/settings/providerlinxio.metadata.providers()

Returns dashboard provider settings visible to the account.

Query parameters

none
void
optional
No query parameters are required.

Response

data
LinxioProviderSetting[]
optional
Provider setting records.

GET /settings/digitalForm

GET

Get digital form settings

/settings/digitalFormlinxio.metadata.digitalFormSettings()

Returns tenant-level digital-form settings.

Query parameters

none
void
optional
No query parameters are required.

Response

data
LinxioDigitalFormSettings
optional
Digital-form feature settings.

GET /settings/ecoSpeed

GET

Get eco-speed settings

/settings/ecoSpeedlinxio.metadata.ecoSpeedSettings()

Returns tenant-level eco-speed settings.

Query parameters

none
void
optional
No query parameters are required.

Response

data
LinxioEcoSpeedSettings
optional
Eco-speed feature settings.

GET /settings/excessiveIdling

GET

Get excessive-idling settings

/settings/excessiveIdlinglinxio.metadata.excessiveIdlingSettings()

Returns tenant-level excessive-idling settings.

Query parameters

none
void
optional
No query parameters are required.

Response

data
LinxioExcessiveIdlingSettings
optional
Excessive-idling feature settings.

Reports and Forms

Scheduled report and digital form answer HTTP endpoints.

Realtime

Socket.IO realtime coordinate and notification namespaces.

On this page

GET /country/listGET /rolesGET /plansGET /timezonesGET /themesGET /themes/myGET /permissions/current-planGET /platform-settings/domainGET /settings/language/listGET /settings/mapApiOptionsGET /settings/providerGET /settings/digitalFormGET /settings/ecoSpeedGET /settings/excessiveIdling