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.

Important

Account and reseller endpoints are tenant-permission sensitive. In the live validation tenant, /clients/{clientId}/users was available for client-scoped users, while /users, /clients/json, and /reseller were unavailable or permission-gated for the supplied account.

GET /users

GET

List users

/userslinxio.users.list(params)

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

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

number

optional

Number of records per page.

number

optional

Page number to read.

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.

Response body fields

LinxioUser[]

optional

Users for the current page.

Show child parameters

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.

number

optional

Pagination metadata.

Request

curl "https://api.linxio.com/api/users?fields[]=id&fields[]=email&limit=100" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


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

GET `/users/{userId}`

GET

Get a user

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

Returns one user by ID.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

User identifier.

Response body fields

LinxioId

optional

User identifier.

string

optional

Email address when supplied.

string

optional

Display name when supplied.

string

optional

Role name when supplied.

Request

curl "https://api.linxio.com/api/users/123" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


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

POST /users

POST

Create a user

/userslinxio.users.create(payload)

Creates a user.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request body 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.

Response body fields

LinxioId

optional

Created user ID.

Request

curl -X POST https://api.linxio.com/api/users \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "email": "new-user@example.com",
    "firstName": "New",
    "lastName": "User",
    "roleId": 7
  }'

Example response


{
  "id": 64553
}

PATCH `/users/{userId}`

PATCH

Update a user

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

Updates a user.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Path and body parameters

LinxioId

required

User identifier.

LinxioUserPayload

required

Fields to update.

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.

Response body fields

LinxioId

optional

Updated user ID.

Request

curl -X PATCH https://api.linxio.com/api/users/123 \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "phone": "+61 400 000 000"
  }'

Example response


{
  "id": 64553
}

PATCH `/users/{userId}/archive`

PATCH

Archive a user

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

Soft-archives a user.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request url parameters

LinxioId

required

User identifier.

Response headers

204 or JSON

optional

Successful archive response.

Request

curl -X PATCH https://api.linxio.com/api/users/123/archive \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Example response


{
  "status": "online"
}

PATCH `/users/{userId}/restore`

PATCH

Restore a user

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

Restores a previously archived user.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request url parameters

LinxioId

required

Archived user identifier.

Response headers

204 or JSON

optional

Successful restore response.

Request

curl -X PATCH https://api.linxio.com/api/users/123/restore \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Example response


{
  "status": "online"
}

GET /clients/json

GET

List client accounts

/clients/jsonlinxio.clients.list(params)

Returns a paginated list of client accounts.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

number

optional

Number of records per page.

number

optional

Page number to read.

string[]

optional

Optional client-account field projection.

QueryValue

optional

Dashboard-derived filters.

Response body fields

LinxioId

optional

Client account identifier.

string

optional

Client account display name when supplied.

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.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Client account identifier.

Response body fields

LinxioId

optional

Client account identifier.

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.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Path and query parameters

LinxioId

required

Client account identifier.

string

optional

Optional role filter, such as driver.

number

optional

Number of records per page.

number

optional

Page number to read.

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.

Response body fields

LinxioUser[]

optional

Client users for the current page.

Show child parameters

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.

number

optional

Pagination metadata.

Request

curl "https://api.linxio.com/api/clients/10/users?role=driver&limit=100" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


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

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.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Client account identifier.

LinxioId

required

User identifier.

Response body fields

LinxioId

optional

User identifier.

string

optional

Email when supplied.

string

optional

Display name when supplied.

Request

curl "https://api.linxio.com/api/clients/10/users/123" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "id": 64553,
  "email": "user@example.com",
  "fullName": "Example User"
}

POST `/clients/{clientId}/users`

POST

Create a client user

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

Creates a user inside a client account.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Path and body parameters

LinxioId

required

Client account identifier.

string

optional

User email address.

string

optional

Given name.

string

optional

Family name.

string

optional

Phone number.

LinxioId

optional

Role identifier.

Response body fields

LinxioId

optional

Created user ID.

Request

curl -X POST https://api.linxio.com/api/clients/10/users \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "email": "driver@example.com",
    "firstName": "Driver",
    "lastName": "Example",
    "roleId": 7
  }'

Example response


{
  "id": 64553
}

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.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Path and body parameters

LinxioId

required

Client account identifier.

LinxioId

required

User identifier.

LinxioUserPayload

required

Fields to update.

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.

Response body fields

LinxioId

optional

Updated user ID.

Request

curl -X POST https://api.linxio.com/api/clients/10/users/123 \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "phone": "+61 400 000 000"
  }'

Example response


{
  "id": 64553
}

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.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

number

optional

Number of records per page.

number

optional

Page number to read.

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.

Response body fields

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.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Path and query parameters

LinxioId

required

Client account identifier.

driver

required

Driver role filter.

number

optional

Number of records per page.

number

optional

Page number to read.

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.

Response body fields

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.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request url parameters

LinxioId

required

Vehicle identifier.

LinxioId

required

Driver user identifier.

Response headers

204 or JSON

optional

Successful assignment response.

Request

curl -X POST https://api.linxio.com/api/vehicle/304/set-driver/123 \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Example response


{
  "status": "online"
}

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.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request url parameters

LinxioId

required

Vehicle identifier.

LinxioId

required

Driver user identifier.

Response headers

204 or JSON

optional

Successful unassignment response.

Request

curl -X POST https://api.linxio.com/api/vehicle/304/unset-driver/123 \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Example response


{
  "status": "online"
}

GET /reseller

GET

List reseller accounts

/resellerlinxio.resellers.list()

Lists reseller accounts visible 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

Reseller identifier.

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.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Reseller identifier.

Response body fields

LinxioId

optional

Reseller identifier.

string

optional

Reseller display name when supplied.

Accounts, Users, and Drivers

List users

Request headers

Request query parameters

Response body fields

Get a user

Request headers

Request url parameters

Response body fields

Create a user

Request headers

Request body parameters

Response body fields

Update a user

Request headers

Path and body parameters

Response body fields

Archive a user

Request headers

Request url parameters

Response headers

Restore a user

Request headers

Request url parameters

Response headers

List client accounts

Request headers

Request query parameters

Response body fields

Get a client account

Request headers

Request url parameters

Response body fields

List client users

Request headers

Path and query parameters

Response body fields

Get a client user

Request headers

Request url parameters

Response body fields

Create a client user

Request headers

Path and body parameters

Response body fields

Update a client user

Request headers

Path and body parameters

Response body fields

List drivers

Request headers

Request query parameters

Response body fields

List client drivers

Request headers

Path and query parameters

Response body fields

Assign driver to vehicle

Request headers

Request url parameters

Response headers

Unassign driver from vehicle

Request headers

Request url parameters

Response headers

List reseller accounts

Request headers

Request query parameters

Response body fields

Get a reseller account

Request headers

Request url parameters

Response body fields

On this page