API docs by Redocly

api.trucesoftware.com (3.1.5)

View Documentation

Displays this documentation.

Responses

beacons

Get a List of Beacons

Retrieve a list of beacons assigned to your account. Narrow your search to a single beacon by including the mac query string parameter.

query Parameters
mac
string

A MAC address of a beacon.

vin
string

A VIN of a beacon.

limit
string

A limit of results for the query. May not be greater than 1000.

offset
string

An offset of results for the query.

header Parameters
Authorization
required
string

A basic authorization header created from your API user's username and password.

Responses

Request samples 

$ curl -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  https://api.trucesoftware.com/beacons

$ curl -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  https://api.trucesoftware.com/beacons?mac=000000000000

Response samples

Content type
application/json
{
  • "requestTimestamp": "string",
  • "beacons": [
    ]
}

Update a beacon

Update a beacons information

path Parameters
mac
required
string
header Parameters
Authorization
required
string
Request Body schema: application/json

Update a beacon.

vin
string

The vin of the beacon.

customId
string

The custom id you want assosiated with this beacon.

number or string

The group you want to set this beacon to.

Responses

Request samples

Content type
application/json
{
  • "vin": "string",
  • "customId": "string",
  • "groupId": 0
}

Response samples

Content type
application/json
{ }

Get a List of Beacons Assigned to a Group

Retrieve a list of beacons assigned to a group on your account.

path Parameters
groupId
required
string
query Parameters
limit
string

A limit of results for the query. May not be greater than 1000.

offset
string

An offset of results for the query.

header Parameters
Authorization
required
string

A basic authorization header created from your API user's username and password.

Responses

Request samples 

$ curl -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  https://api.trucesoftware.com/groups/1234/beacons

Response samples

Content type
application/json
{
  • "requestTimestamp": "string",
  • "beacons": [
    ]
}

devices

Get a List of Devices

Returns a list of devices (i.e. phones, tablets, PCs, or any other device) added to your account.

query Parameters
phoneNumber
string

A phone number of a device. If the device does not have cellular service, this value may be also a serial number or some other unique identifier. They also must be unique system wide.

employeeId
string

The company's custom identifier of the employee to which devices are assigned.

username
string

The username of the employee to which devices are assigned. They also must be unique system wide.

limit
string

A limit of results for the query. May not be greater than 1000.

offset
string

An offset of results for the query.

header Parameters
Authorization
required
string

A basic authorization header created from your API user's username and password.

Responses

Request samples 

$ curl -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  https://api.trucesoftware.com/devices

$ curl -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  https://api.trucesoftware.com/devices?phoneNumber=5555555555

$ curl -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  https://api.trucesoftware.com/devices?username=foo

$ curl -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  https://api.trucesoftware.com/devices?employeeId=bar

Response samples

Content type
application/json
{
  • "requestTimestamp": "string",
  • "devices": [
    ]
}

Delete a Device

Delete a device from an account.

path Parameters
phoneNumber
required
string

The phone number of the device which must be unique system wide.

header Parameters
Authorization
required
string

A basic authorization header created from your API user's username and password.

Responses

Response samples

Content type
application/json
{
  • "requestTimestamp": "string",
  • "devices": [
    ]
}

Get a List of Devices Assigned to a Group

Returns a list of devices (i.e. phones, tablets, PCs, or any other device) assigned to users of a group.

path Parameters
groupId
required
string
query Parameters
limit
string

A limit of results for the query. May not be greater than 1000.

offset
string

An offset of results for the query.

header Parameters
Authorization
required
string

A basic authorization header created from your API user's username and password.

Responses

Request samples 

$ curl -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  https://api.trucesoftware.com/groups/1234/devices

Response samples

Content type
application/json
{
  • "requestTimestamp": "string",
  • "devices": [
    ]
}

Get a List of Devices Assigned To an Employee

Returns a list of devices (i.e. phones, tablets, PCs, or any other device) assigned to an employee on your account.

path Parameters
userId
required
string

The internal TRUCE identifier of an employee.

query Parameters
limit
string

A limit of results for the query. May not be greater than 1000.

offset
string

An offset of results for the query.

header Parameters
Authorization
required
string

A basic authorization header created from your API user's username and password.

Responses

Response samples

Content type
application/json
{
  • "requestTimestamp": "string",
  • "devices": [
    ]
}

groups

Get a List of Groups

Returns a list of groups on your account.

query Parameters
limit
string

A limit of results for the query. May not be greater than 1000.

offset
string

An offset of results for the query.

header Parameters
Authorization
required
string

A basic authorization header created from your API user's username and password.

Responses

Request samples 

$ curl -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  https://api.trucesoftware.com/beacons/groups

Response samples

Content type
application/json
{
  • "requestTimestamp": "string",
  • "groups": [
    ]
}

Create a group

A way to create a group via api.

header Parameters
Authorization
string
Request Body schema: application/json

Create a group.

name
string

The name of the group you are creating.

parentName
string

The name of the parent for the group you are creating.

address
string

A group's address.

city
string

A group's city.

state
string

The state a group exists in

zip
string

A group's zip.

country
string

A group's country.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parentName": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "string"
}

Response samples

Content type
application/json
{ }

Get One Group

Returns a group on your account.

path Parameters
groupId
required
string
header Parameters
Authorization
required
string

A basic authorization header created from your API user's username and password.

Responses

Request samples 

$ curl -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  https://api.trucesoftware.com/beacons/groups/1234

Response samples

Content type
application/json
{
  • "requestTimestamp": "string",
  • "groups": [
    ]
}

Update a group

Update a groups information.

path Parameters
groupId
required
string
header Parameters
Authorization
required
string
Request Body schema: application/json

Update a group.

name
string

The name of the group.

city
string

The city of the group.

state
string

The state of the group.

zip
string

The zipcode of the group.

country
string
address
string

The address of the group.

number or string

Id of the group you want to set as the parent

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "string",
  • "address": "string",
  • "parentId": 0
}

Response samples

Content type
application/json
{ }

Delete a Group

Delete a group from an account.

path Parameters
groupId
required
string
header Parameters
Authorization
string

Responses

Response samples

Content type
application/json
{ }

employees

Get a List of Employees Assigned to a Group

Returns a list of employees assigned to a group.

path Parameters
groupId
required
string
query Parameters
limit
string

A limit of results for the query. May not be greater than 1000.

offset
string

An offset of results for the query.

header Parameters
Authorization
required
string

A basic authorization header created from your API user's username and password.

Responses

Request samples 

$ curl -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  https://api.trucesoftware.com/groups/1234/employees

Response samples

Content type
application/json
{ }

Get a List of Employees

Returns a list of employees assigned to your account.

query Parameters
username
string

The username of a user assigned to your account. They also must be unique system wide.

userId
string

The internal TRUCE identifier of a employee assigned to your account.

employeeId
string

The company's custom employee identifier.

limit
string

A limit of results for the query. May not be greater than 1000.

offset
string

An offset of results for the query.

header Parameters
Authorization
required
string

A basic authorization header created from your API user's username and password.

Responses

Request samples 

$ curl -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  https://api.trucesoftware.com/employees

$ curl -H "Content-Type: application/json" \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  https://api.trucesoftware.com/employees?username=foo

Response samples

Content type
application/json
{
  • "requestTimestamp": "string",
  • "employees": [
    ]
}

Create an Employee

Allows you to create an employee.

header Parameters
Authorization
string

A basic authorization header created from your API user's username and password.

Request Body schema: application/json

Create an Employee.

zip
string

The zip of the employee.

lastName
string

The last name of the employee.

address
string

The address of the employee.

city
string

The city of the employee.

state
string

The state of the employee.

number or string

The policy that you want the user to be a part of

Array of objects

A list of devices to be associated with this employee.

admin
boolean

Determines whether the employee is an admin.

employeeId
string

A unique identifier for the employee. In typical usage, this will correlate with an identifier in an external database or system.

firstName
string

The first name of the employee.

password
string

The password of the employee.

overrideBlocking
boolean

Determines whether the employee is able to override blocking.

email
string

The email address of the employee.

username
string

The username of the employee which must be unique system wide.

group
string

The name of the group to which the employee should be added.

jobTitle
string

Job title of the employee.

jobCode
string

Job code of the employee.

notes
string

The notes about an employee.

object

Fine-grained control of admin settings

Responses

Request samples

Content type
application/json
{
  • "zip": "string",
  • "lastName": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "policyId": 0,
  • "devices": [
    ],
  • "admin": true,
  • "employeeId": "string",
  • "firstName": "string",
  • "password": "string",
  • "overrideBlocking": true,
  • "email": "string",
  • "username": "string",
  • "group": "string",
  • "jobTitle": "string",
  • "jobCode": "string",
  • "notes": "string",
  • "adminSettings": {
    }
}

Response samples

Content type
application/json
{
  • "userId": 0
}

Get an Employee

Returns an employee assigned to your account.

path Parameters
userId
required
string

The internal TRUCE identifier for an employee.

header Parameters
Authorization
required
string

A basic authorization header created from your API user's username and password.

Responses

Response samples

Content type
application/json
{
  • "requestTimestamp": "string",
  • "employees": [
    ]
}

Update an employee

Update an employee's information which includes updating an employee's phone number.

path Parameters
userId
required
string

An internal TRUCE identifier for an employee

header Parameters
Authorization
required
string
Request Body schema: application/json

Update an Employee.

userName
string

The username of the employee which must be unique system wide.

city
string

The city of the employee.

state
string

The state of the employee.

zip
string

The zipcode of the employee.

address
string

The address of the employee.

firstName
string

First name of the employee

lastName
string

Last name of the employee

employeeId
string

Provided external id of the employee

number or string

Group id of the group you want that user assigned to.

email
string

The email of the employee.

number or string

The policy this employee is assigned to

jobTitle
string

Job title of the employee.

jobCode
string

Job code of the employee.

notes
string

Notes about an employee

Array of objects

A list of devices to be associated with this employee.

admin
boolean

Determines whether the employee is an admin.

object

Fine-grained control of admin settings

Responses

Request samples

Content type
application/json
{
  • "userName": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "address": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "employeeId": "string",
  • "groupId": 0,
  • "email": "string",
  • "policyId": 0,
  • "jobTitle": "string",
  • "jobCode": "string",
  • "notes": "string",
  • "devices": [
    ],
  • "admin": true,
  • "adminSettings": {
    }
}

Response samples

Content type
application/json
{ }

Delete an Employee

Delete an employee from your account.

path Parameters
userId
required
string

The internal TRUCE identifier of an employee.

header Parameters
Authorization
required
string

A basic authorization header created from your API user's username and password.

Responses

Response samples

Content type
application/json
{
  • "userId": 0
}

policies

Get a list of Policy

Returns a list of the entity's policy.

query Parameters
userId
string

The internal TRUCE identifier of an employee.

policyId
string

The internal TRUCE identifier of an policy.

policyName
string

The name of an policy.

limit
string

The the amount of records you want to retrieve at one time (max = 100).

offset
string

The how many records you want to offset your results by.

header Parameters
Authorization
required
string

A basic authorization header created from your API user's username and password.

Responses

Response samples

Content type
application/json
{
  • "policy": [
    ],
  • "requestTimestamp": "string"
}

sessions

Get a List of Sessions

Retrieve all sessions

query Parameters
phoneNumber
string
rangeStartTime
string
rangeEndTime
string
mac
string
limit
string
day
string
offset
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sessions": [
    ],
  • "requestTimestamp": "string"
}

Get a List of Sessions By Session Id

Retrieve session information from a sessions I.D

path Parameters
sessionId
required
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sessions": [
    ],
  • "requestTimestamp": "string"
}

Get a List of Aggregated Sessions

Get a List of Aggregated Sessions by Date

path Parameters
date
required
string
query Parameters
limit
string

A limit of results for the query. May not be greater than 1000.

offset
string

An offset of results for the query.

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "requestTimestamp": "string",
  • "aggregates": [
    ]
}

Get a List of Sessions By Employee

Retrieve all sessions of a particular employee

path Parameters
userId
required
string

The internal TRUCE identifier of an employee

query Parameters
rangeStartTime
string
rangeEndTime
string
day
string
limit
string
offset
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sessions": [
    ],
  • "requestTimestamp": "string"
}

Get a List of Sessions By Group

Retrieve all sessions of a particular group

path Parameters
groupId
required
string
query Parameters
limit
string

A limit of results for the query. May not be greater than 1000.

offset
string

An offset of results for the query.

header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sessions": [
    ],
  • "requestTimestamp": "string"
}