linxio-js
API Reference

Accounts, Users, and Drivers

Client accounts, account users, client users, drivers, driver assignment, and resellers.

The SDK exposes related account APIs through several services. Use /users for account-level user management, /clients/{clientId}/users for users inside a client account, and driver assignment endpoints for vehicle-driver links.

GET /users

GET

List users

/userslinxio.users.list(params)

Returns a paginated list of users visible to the authenticated account.

Query parameters

limit
number
optional
Number of records per page.
page
number
optional
Page number to read.
fields[]
string[]
optional
Optional field projection such as id, email, fullName, role, or status.
role
string
optional
Optional role filter.

Response fields

data
LinxioUser[]
optional
Users for the current page.
page / limit / total
number
optional
Pagination metadata.

GET /users/{userId}

GET

Get a user

/users/{userId}linxio.users.get(userId)

Returns one user by ID.

Path parameters

userId
LinxioId
required
User identifier.

Response fields

id
LinxioId
optional
User identifier.
email
string
optional
Email address when supplied.
fullName
string
optional
Display name when supplied.
role
string
optional
Role name when supplied.

POST /users

POST

Create a user

/userslinxio.users.create(payload)

Creates a user.

Body parameters

email
string
optional
User email address.
firstName
string
optional
Given name.
lastName
string
optional
Family name.
fullName
string
optional
Full display name.
phone
string
optional
Phone number.
roleId
LinxioId
optional
Role identifier.

Response fields

id
LinxioId
optional
Created user ID.

PATCH /users/{userId}

PATCH

Update a user

/users/{userId}linxio.users.update(userId, payload)

Updates a user.

Path and body parameters

userId
LinxioId
required
User identifier.
body
LinxioUserPayload
required
Fields to update.

Response fields

id
LinxioId
optional
Updated user ID.

PATCH /users/{userId}/archive

PATCH

Archive a user

/users/{userId}/archivelinxio.users.archive(userId)

Soft-archives a user.

Path parameters

userId
LinxioId
required
User identifier.

Response

status
204 or JSON
optional
Successful archive response.

PATCH /users/{userId}/restore

PATCH

Restore a user

/users/{userId}/restorelinxio.users.restore(userId)

Restores a previously archived user.

Path parameters

userId
LinxioId
required
Archived user identifier.

Response

status
204 or JSON
optional
Successful restore response.

GET /clients/json

GET

List client accounts

/clients/jsonlinxio.clients.list(params)

Returns a paginated list of client accounts.

Query parameters

limit
number
optional
Number of records per page.
page
number
optional
Page number to read.
fields[]
string[]
optional
Optional field projection.
[filter]
QueryValue
optional
Dashboard-derived filters.

Response fields

id
LinxioId
optional
Client account identifier.
name
string
optional
Client account display name when supplied.
timezone
LinxioId
optional
Timezone identifier when supplied.

GET /clients/{clientId}

GET

Get a client account

/clients/{clientId}linxio.clients.get(clientId)

Returns one client account by ID.

Path parameters

clientId
LinxioId
required
Client account identifier.

Response fields

id
LinxioId
optional
Client account identifier.
name
string
optional
Client account display name when supplied.

GET /clients/{clientId}/users

GET

List client users

/clients/{clientId}/userslinxio.clients.listUsers(clientId, params)

Returns a paginated list of users for a client account.

Path and query parameters

clientId
LinxioId
required
Client account identifier.
role
string
optional
Optional role filter, such as driver.
limit
number
optional
Number of records per page.
page
number
optional
Page number to read.
fields[]
string[]
optional
Optional field projection.

Response fields

data
LinxioUser[]
optional
Client users for the current page.
page / limit / total
number
optional
Pagination metadata.

GET /clients/{clientId}/users/{userId}

GET

Get a client user

/clients/{clientId}/users/{userId}linxio.clients.getUser(clientId, userId)

Returns one user within a client account.

Path parameters

clientId
LinxioId
required
Client account identifier.
userId
LinxioId
required
User identifier.

Response fields

id
LinxioId
optional
User identifier.
email
string
optional
Email when supplied.
fullName
string
optional
Display name when supplied.

POST /clients/{clientId}/users

POST

Create a client user

/clients/{clientId}/userslinxio.clients.createUser(clientId, payload)

Creates a user inside a client account.

Path and body parameters

clientId
LinxioId
required
Client account identifier.
email
string
optional
User email address.
firstName
string
optional
Given name.
lastName
string
optional
Family name.
phone
string
optional
Phone number.
roleId
LinxioId
optional
Role identifier.

Response fields

id
LinxioId
optional
Created user ID.

POST /clients/{clientId}/users/{userId}

POST

Update a client user

/clients/{clientId}/users/{userId}linxio.clients.updateUser(clientId, userId, payload)

Updates a user inside a client account.

Path and body parameters

clientId
LinxioId
required
Client account identifier.
userId
LinxioId
required
User identifier.
body
LinxioUserPayload
required
Fields to update.

Response fields

id
LinxioId
optional
Updated user ID.

GET /drivers

GET

List drivers

/driverslinxio.drivers.list(params)

Returns a paginated list of drivers using the dashboard-derived endpoint when clientId is not supplied to the SDK.

Query parameters

limit
number
optional
Number of records per page.
page
number
optional
Page number to read.
fields[]
string[]
optional
Optional field projection.

Response fields

data
LinxioDriver[]
optional
Driver records for the current page.

GET /clients/{clientId}/users?role=driver

GET

List client drivers

/clients/{clientId}/users?role=driverlinxio.drivers.list({ clientId })

Lists drivers through the documented client-users endpoint.

Path and query parameters

clientId
LinxioId
required
Client account identifier.
role
driver
required
Driver role filter.
limit
number
optional
Number of records per page.
page
number
optional
Page number to read.

Response fields

data
LinxioDriver[]
optional
Driver user records.

POST /vehicle/{vehicleId}/set-driver/{driverId}

POST

Assign driver to vehicle

/vehicle/{vehicleId}/set-driver/{driverId}linxio.drivers.assignToVehicle(vehicleId, driverId)

Assigns a driver to a vehicle.

Path parameters

vehicleId
LinxioId
required
Vehicle identifier.
driverId
LinxioId
required
Driver user identifier.

Response

status
204 or JSON
optional
Successful assignment response.

POST /vehicle/{vehicleId}/unset-driver/{driverId}

POST

Unassign driver from vehicle

/vehicle/{vehicleId}/unset-driver/{driverId}linxio.drivers.unassignFromVehicle(vehicleId, driverId)

Removes a driver assignment from a vehicle.

Path parameters

vehicleId
LinxioId
required
Vehicle identifier.
driverId
LinxioId
required
Driver user identifier.

Response

status
204 or JSON
optional
Successful unassignment response.

GET /reseller

GET

List reseller accounts

/resellerlinxio.resellers.list()

Lists reseller accounts visible to the authenticated account.

Query parameters

none
void
optional
No query parameters are required.

Response fields

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

GET /reseller/{resellerId}

GET

Get a reseller account

/reseller/{resellerId}linxio.resellers.get(resellerId)

Returns one reseller account by ID.

Path parameters

resellerId
LinxioId
required
Reseller identifier.

Response fields

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

Devices, Sensors, and Cameras

Device inventory, install/uninstall, coordinate history, sensor reports, and camera event endpoints.

Geofences

Geofence area and area-group HTTP endpoints.

On this page

GET /usersGET /users/{userId}POST /usersPATCH /users/{userId}PATCH /users/{userId}/archivePATCH /users/{userId}/restoreGET /clients/jsonGET /clients/{clientId}GET /clients/{clientId}/usersGET /clients/{clientId}/users/{userId}POST /clients/{clientId}/usersPOST /clients/{clientId}/users/{userId}GET /driversGET /clients/{clientId}/users?role=driverPOST /vehicle/{vehicleId}/set-driver/{driverId}POST /vehicle/{vehicleId}/unset-driver/{driverId}GET /resellerGET /reseller/{resellerId}