Users, Clients, Drivers, and Resellers

User management, client account users, driver assignment, and reseller account helpers.

Important

These services are related but not interchangeable. linxio.users works at the account user endpoint, linxio.clients works with client accounts and their users, linxio.drivers focuses on driver workflows, and linxio.resellers exposes reseller account lookup.

users.list()

GET

List users

/userslinxio.users.list(params)

Loads one page of users visible to the authenticated account.

Input

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

number

optional

Number of users to request.

number

optional

Page number to request.

Default: 1

UserField[]

optional

User fields to include in the response projection.

Possible enum values

id

User identifier.

email

User email address.

fullName

User display name when supplied.

name

User given name.

surname

User surname.

role

User role label.

status

User status.

string

optional

Optional role filter.

Returns

LinxioUser[] | null

optional

Users for the requested page.

Show child fields

string | null

optional

User email address.

string | null

optional

User display name.

LinxioId

required

User identifier.

string | null

optional

Role label.

string | null

optional

User status.

LinxioPaginationMeta | null

optional

Pagination metadata.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when the page fails.

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.

List users

const users = await linxio.users.list({
  fields: ["id", "email", "fullName", "role"],
  limit: 100,
});

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

Example response


{
  "data": [
    {
      "email": "user@example.com",
      "fullName": "Example User",
      "id": 64553,
      "role": "string",
      "status": "online"
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

users.iterate()

GET

Load all users

/userslinxio.users.iterate(params)

Auto-paginates all user pages and returns a single result object.

Input

LinxioUserListParams

optional

Same filters and field projection as users.list().

Show child parameters

UserField[]

optional

User fields to include in the response projection.

Possible enum values

id

User identifier.

email

User email address.

fullName

User display name when supplied.

name

User given name.

surname

User surname.

role

User role label.

status

User status.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

string

optional

Optional role filter.

Returns

LinxioUser[] | null

optional

Flat array containing every loaded user.

Show child fields

string | null

optional

User email address.

string | null

optional

User display name.

LinxioId

required

User identifier.

string | null

optional

Role label.

string | null

optional

User status.

LinxioError | null

optional

Typed SDK error if any page fails.

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.

Iterate users

const { data: users, error } = await linxio.users.iterate({
  fields: ["id", "email", "status"],
  limit: 100,
});

if (error) {
  throw error;
}

Example response


{
  "data": [
    {
      "email": "user@example.com",
      "fullName": "Example User",
      "id": 64553,
      "role": "string",
      "status": "online"
    }
  ],
  "error": null
}

users.stream()

GET

Stream users

/userslinxio.users.stream(params)

Streams users lazily across pages.

Input

LinxioUserListParams

optional

Same filters and field projection as users.list().

Show child parameters

UserField[]

optional

User fields to include in the response projection.

Possible enum values

id

User identifier.

email

User email address.

fullName

User display name when supplied.

name

User given name.

surname

User surname.

role

User role label.

status

User status.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

string

optional

Optional role filter.

Returns

LinxioUser

optional

One user at a time.

Show child fields

string | null

optional

User email address.

string | null

optional

User display name.

LinxioId

required

User identifier.

string | null

optional

Role label.

string | null

optional

User status.

LinxioError

optional

Thrown if a page request fails.

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.

Stream users

for await (const user of linxio.users.stream({ limit: 100 })) {
  console.log(user.id, user.email);
}

Example response


{
  "yield": {
    "email": "user@example.com",
    "fullName": "Example User",
    "id": 64553,
    "role": "string",
    "status": "online"
  }
}

users.get()

GET

Get a user

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

Fetches one user by ID.

Input

LinxioId

required

User identifier.

Returns

LinxioUser | null

optional

User record.

Show child fields

string | null

optional

User email address.

string | null

optional

User display name.

LinxioId

required

User identifier.

string | null

optional

Role label.

string | null

optional

User status.

LinxioError | null

optional

Typed SDK error when the user 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.

Get user

const user = await linxio.users.get(userId);

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

Example response


{
  "data": {
    "email": "user@example.com",
    "fullName": "Example User",
    "id": 64553,
    "role": "string",
    "status": "online"
  },
  "error": null
}

users.create()

POST

Create a user

/userslinxio.users.create(payload)

Creates a user. Role and permission validation depends on the authenticated account and tenant configuration.

Input

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

string

optional

User email address.

string

optional

Given name.

string

optional

Family name.

string

optional

Full display name.

string

optional

Phone number.

LinxioId

optional

Role identifier from metadata.roles().

Returns

LinxioUser | null

optional

Created user.

Show child fields

string | null

optional

User email address.

string | null

optional

User display name.

LinxioId

required

User identifier.

string | null

optional

Role label.

string | null

optional

User status.

LinxioError | null

optional

Typed SDK error when creation fails.

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.

Create user

const created = await linxio.users.create({
  email: "new-user@example.com",
  firstName: "New",
  lastName: "User",
  roleId,
});

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

Example response


{
  "data": {
    "email": "user@example.com",
    "fullName": "Example User",
    "id": 64553,
    "role": "string",
    "status": "online"
  },
  "error": null
}

users.update()

PATCH

Update a user

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

Updates a user.

Input

LinxioId

required

User identifier.

LinxioUserPayload

required

Partial user payload containing fields to change.

Show child parameters

string

optional

User email address.

string

optional

Given name.

string

optional

Full display name.

string

optional

Family name.

string

optional

Phone number.

LinxioId

optional

Role identifier.

Returns

LinxioUser | null

optional

Updated user.

Show child fields

string | null

optional

User email address.

string | null

optional

User display name.

LinxioId

required

User identifier.

string | null

optional

Role label.

string | null

optional

User status.

LinxioError | null

optional

Typed SDK error when update fails.

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.

Update user

const updated = await linxio.users.update(userId, {
  phone: "+61 400 000 000",
});

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

Example response


{
  "data": {
    "email": "user@example.com",
    "fullName": "Example User",
    "id": 64553,
    "role": "string",
    "status": "online"
  },
  "error": null
}

users.archive()

PATCH

Archive a user

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

Soft-archives a user.

Input

LinxioId

required

User identifier.

Returns

void

optional

Undefined on success.

LinxioError | null

optional

Typed SDK error when archive fails.

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.

users.restore()

PATCH

Restore a user

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

Restores a previously archived user.

Input

LinxioId

required

Archived user identifier.

Returns

void

optional

Undefined on success.

LinxioError | null

optional

Typed SDK error when restore fails.

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.

clients.list()

GET

List client accounts

/clients/jsonlinxio.clients.list(params)

Loads one page of client accounts visible to the authenticated account.

Input

LinxioClientUserListParams

optional

Pagination, field projection, sorting, role, and dashboard-derived filters.

Show child parameters

FieldSelector<TField>

optional

Field projection sent as repeated fields[] query parameters.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

string

optional

Optional role filter.

Returns

LinxioClientAccount[] | null

optional

Client account records.

Show child fields

LinxioId

required

Client account identifier.

string | null

optional

Client account display name.

LinxioId | null

optional

Timezone identifier when supplied.

LinxioPaginationMeta | null

optional

Pagination metadata.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when the page fails.

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.

List clients

const clients = await linxio.clients.list({ limit: 100 });

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

Example response


{
  "data": [
    {
      "id": 64553,
      "name": "Example",
      "timezone": 64553
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

clients.get()

GET

Get a client account

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

Fetches one client account by ID.

Input

LinxioId

required

Client account identifier.

Returns

LinxioClientAccount | null

optional

Client account record.

Show child fields

LinxioId

required

Client account identifier.

string | null

optional

Client account display name.

LinxioId | null

optional

Timezone identifier when supplied.

LinxioError | null

optional

Typed SDK error when the client 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.

Get client

const client = await linxio.clients.get(clientId);

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

Example response


{
  "data": {
    "id": 64553,
    "name": "Example",
    "timezone": 64553
  },
  "error": null
}

clients.listUsers()

GET

List client users

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

Loads one page of users for a client account.

Input

LinxioId

required

Client account identifier.

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

string

optional

Optional role filter, such as driver.

number

optional

Number of users to request.

number

optional

Page number to request.

Default: 1

UserField[]

optional

User fields to include in the response projection.

Possible enum values

id

User identifier.

email

User email address.

fullName

User display name when supplied.

name

User given name.

surname

User surname.

role

User role label.

status

User status.

Returns

LinxioUser[] | null

optional

Client users for the requested page.

Show child fields

string | null

optional

User email address.

string | null

optional

User display name.

LinxioId

required

User identifier.

string | null

optional

Role label.

string | null

optional

User status.

LinxioPaginationMeta | null

optional

Pagination metadata.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when the page fails.

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.

List client users

const users = await linxio.clients.listUsers(clientId, {
  role: "driver",
  limit: 100,
});

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

Example response


{
  "data": [
    {
      "email": "user@example.com",
      "fullName": "Example User",
      "id": 64553,
      "role": "string",
      "status": "online"
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

clients.iterateUsers()

GET

Load all client users

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

Auto-paginates users for one client account.

Input

LinxioId

required

Client account identifier.

LinxioClientUserListParams

optional

Same filters as clients.listUsers().

Show child parameters

FieldSelector<TField>

optional

Field projection sent as repeated fields[] query parameters.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

string

optional

Optional role filter.

Returns

LinxioUser[] | null

optional

Flat array containing every loaded client user.

Show child fields

string | null

optional

User email address.

string | null

optional

User display name.

LinxioId

required

User identifier.

string | null

optional

Role label.

string | null

optional

User status.

LinxioError | null

optional

Typed SDK error if any page fails.

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.

Iterate client users

const { data: users, error } = await linxio.clients.iterateUsers(clientId, {
  limit: 100,
});

if (error) {
  throw error;
}

Example response


{
  "data": [
    {
      "email": "user@example.com",
      "fullName": "Example User",
      "id": 64553,
      "role": "string",
      "status": "online"
    }
  ],
  "error": null
}

clients.streamUsers()

GET

Stream client users

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

Streams client users lazily across pages.

Input

LinxioId

required

Client account identifier.

LinxioClientUserListParams

optional

Same filters as clients.listUsers().

Show child parameters

FieldSelector<TField>

optional

Field projection sent as repeated fields[] query parameters.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

string

optional

Optional role filter.

Returns

LinxioUser

optional

One client user at a time.

Show child fields

string | null

optional

User email address.

string | null

optional

User display name.

LinxioId

required

User identifier.

string | null

optional

Role label.

string | null

optional

User status.

LinxioError

optional

Thrown if a page request fails.

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.

Stream client users

for await (const user of linxio.clients.streamUsers(clientId, { limit: 100 })) {
  console.log(user.id, user.email);
}

Example response


{
  "yield": {
    "email": "user@example.com",
    "fullName": "Example User",
    "id": 64553,
    "role": "string",
    "status": "online"
  }
}

clients.getUser()

GET

Get a client user

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

Fetches one user within a client account.

Input

LinxioId

required

Client account identifier.

LinxioId

required

User identifier within that client account.

Returns

LinxioUser | null

optional

Client user record.

Show child fields

string | null

optional

User email address.

string | null

optional

User display name.

LinxioId

required

User identifier.

string | null

optional

Role label.

string | null

optional

User status.

LinxioError | null

optional

Typed SDK error when the user 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.

Get client user

const user = await linxio.clients.getUser(clientId, userId);

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

Example response


{
  "data": {
    "email": "user@example.com",
    "fullName": "Example User",
    "id": 64553,
    "role": "string",
    "status": "online"
  },
  "error": null
}

clients.createUser()

POST

Create a client user

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

Creates a user inside a client account.

Input

LinxioId

required

Client account identifier.

LinxioUserPayload

required

User fields such as email, name, phone, and roleId.

Show child parameters

string

optional

User email address.

string

optional

Given name.

string

optional

Full display name.

string

optional

Family name.

string

optional

Phone number.

LinxioId

optional

Role identifier.

Returns

LinxioUser | null

optional

Created client user.

Show child fields

string | null

optional

User email address.

string | null

optional

User display name.

LinxioId

required

User identifier.

string | null

optional

Role label.

string | null

optional

User status.

LinxioError | null

optional

Typed SDK error when creation fails.

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.

Create client user

const created = await linxio.clients.createUser(clientId, {
  email: "driver@example.com",
  firstName: "Driver",
  lastName: "Example",
  roleId,
});

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

Example response


{
  "data": {
    "email": "user@example.com",
    "fullName": "Example User",
    "id": 64553,
    "role": "string",
    "status": "online"
  },
  "error": null
}

clients.updateUser()

POST

Update a client user

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

Updates a user inside a client account.

Input

LinxioId

required

Client account identifier.

LinxioId

required

User identifier.

LinxioUserPayload

required

Partial user payload containing fields to change.

Show child parameters

string

optional

User email address.

string

optional

Given name.

string

optional

Full display name.

string

optional

Family name.

string

optional

Phone number.

LinxioId

optional

Role identifier.

Returns

LinxioUser | null

optional

Updated client user.

Show child fields

string | null

optional

User email address.

string | null

optional

User display name.

LinxioId

required

User identifier.

string | null

optional

Role label.

string | null

optional

User status.

LinxioError | null

optional

Typed SDK error when update fails.

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.

Update client user

const updated = await linxio.clients.updateUser(clientId, userId, {
  phone: "+61 400 000 000",
});

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

Example response


{
  "data": {
    "email": "user@example.com",
    "fullName": "Example User",
    "id": 64553,
    "role": "string",
    "status": "online"
  },
  "error": null
}

drivers.list()

GET

List drivers

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

Lists drivers. Pass clientId to use the documented client-users driver endpoint; omit it to use the dashboard-derived /drivers endpoint.

Input

object

optional

Object parameter. Expand to see child parameters.

Show child parameters

LinxioId

optional

Client account identifier. When supplied, role=driver is sent automatically.

number

optional

Number of drivers to request.

DriverField[]

optional

Driver fields to include in the response projection.

Possible enum values

id

Driver user identifier.

fullName

Driver display name.

email

Driver email address.

phone

Driver phone number.

role

Driver role label.

Returns

LinxioDriver[] | null

optional

Drivers for the requested page.

LinxioPaginationMeta | null

optional

Pagination metadata.

Show child fields

number

required

Page size.

number

required

Current page number.

number

required

Total matching record count.

LinxioError | null

optional

Typed SDK error when the page fails.

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.

List drivers for a client

const drivers = await linxio.drivers.list({
  clientId,
  fields: ["id", "fullName", "email"],
  limit: 100,
});

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

Example response


{
  "data": [
    "string"
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "total": 2
  },
  "error": null
}

drivers.iterate()

GET

Load all drivers

/drivers or /clients/{clientId}/users?role=driverlinxio.drivers.iterate(params)

Auto-paginates driver pages into one result object.

Input

LinxioDriverListParams

optional

Same parameters as drivers.list().

Show child parameters

DriverField[]

optional

Driver fields to include in the response projection.

Possible enum values

id

Driver user identifier.

fullName

Driver display name.

email

Driver email address.

phone

Driver phone number.

role

Driver role label.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

LinxioId

optional

Client account identifier. When supplied, the SDK lists client users with role=driver.

Returns

LinxioDriver[] | null

optional

Flat array containing every loaded driver.

LinxioError | null

optional

Typed SDK error if any page fails.

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.

Iterate drivers

const { data: drivers, error } = await linxio.drivers.iterate({
  clientId,
  limit: 100,
});

if (error) {
  throw error;
}

Example response


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

drivers.stream()

GET

Stream drivers

/drivers or /clients/{clientId}/users?role=driverlinxio.drivers.stream(params)

Streams drivers lazily across pages.

Input

LinxioDriverListParams

optional

Same parameters as drivers.list().

Show child parameters

DriverField[]

optional

Driver fields to include in the response projection.

Possible enum values

id

Driver user identifier.

fullName

Driver display name.

email

Driver email address.

phone

Driver phone number.

role

Driver role label.

number

optional

Maximum records to request per page.

number

optional

Page number to request.

Default: 1

string

optional

Sort expression accepted by Linxio for that endpoint.

QueryValue

optional

Additional endpoint-specific filters forwarded as query parameters.

LinxioId

optional

Client account identifier. When supplied, the SDK lists client users with role=driver.

Returns

LinxioDriver

optional

One driver at a time.

LinxioError

optional

Thrown if a page request fails.

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.

drivers.assignToVehicle()

POST

Assign driver to vehicle

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

Assigns a driver to a vehicle.

Input

LinxioId

required

Vehicle receiving the driver assignment.

LinxioId

required

Driver user identifier.

Returns

void

optional

Undefined on success.

LinxioError | null

optional

Typed SDK error when assignment fails.

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.

drivers.unassignFromVehicle()

POST

Unassign driver from vehicle

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

Removes a driver assignment from a vehicle.

Input

LinxioId

required

Vehicle identifier.

LinxioId

required

Driver user identifier.

Returns

void

optional

Undefined on success.

LinxioError | null

optional

Typed SDK error when unassignment fails.

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.

resellers.list()

GET

List reseller accounts

/resellerlinxio.resellers.list()

Lists reseller accounts visible to the authenticated account.

Input

void

optional

list() does not take parameters.

Returns

LinxioReseller[] | null

optional

Reseller account records.

Show child fields

LinxioId

required

Reseller identifier.

string | null

optional

Reseller display name.

LinxioError | null

optional

Typed SDK error when resellers 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.

List resellers

const resellers = await linxio.resellers.list();

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

Example response


{
  "data": [
    {
      "id": 64553,
      "name": "Example"
    }
  ],
  "error": null
}

resellers.get()

GET

Get a reseller account

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

Fetches one reseller account by ID.

Input

LinxioId

required

Reseller identifier.

Returns

LinxioReseller | null

optional

Reseller account record.

Show child fields

LinxioId

required

Reseller identifier.

string | null

optional

Reseller display name.

LinxioError | null

optional

Typed SDK error when the reseller 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.

Get reseller

const reseller = await linxio.resellers.get(resellerId);

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

Example response


{
  "data": {
    "id": 64553,
    "name": "Example"
  },
  "error": null
}

Users, Clients, Drivers, and Resellers

List users

Input

Returns

Load all users

Input

Returns

Stream users

Input

Returns

Get a user

Input

Returns

Create a user

Input

Returns

Update a user

Input

Returns

Archive a user

Input

Returns

Restore a user

Input

Returns

List client accounts

Input

Returns

Get a client account

Input

Returns

List client users

Input

Returns

Load all client users

Input

Returns

Stream client users

Input

Returns

Get a client user

Input

Returns

Create a client user

Input

Returns

Update a client user

Input

Returns

List drivers

Input

Returns

Load all drivers

Input

Returns

Stream drivers

Input

Returns

Assign driver to vehicle

Input

Returns

Unassign driver from vehicle

Input

Returns

List reseller accounts

Input

Returns

Get a reseller account

Input

Returns

On this page