API docs by Redocly

Softruck API Service (1.0.0)

Download OpenAPI specification:Download

Getting started

Introduction

Welcome to the official documentation of the Softruck Public API. This API has been designed to provide seamless integration with Softruck’s tracking and management services, offering a comprehensive suite of endpoints for interacting with vehicles, devices, users, chips, service orders, and enterprises. Additionally, it supports webhooks for real-time, event-driven updates. Below, you’ll find essential information to get started using our API effectively.

API Version

Currently, the latest version of the API is v2. Make sure to regularly check our documentation for updates and new features.

Route Pattern

All requests should be sent to the following base endpoint:

Production

https://api.softruck.com/v2

Development

https://api.apiary.softruck.com/v2

Consumption Limits

To ensure the stability and performance of the API, we apply the following consumption limits:

  • Request Rate: 50 requests per minute.

Authentication

The API uses the standard Bearer Token authentication . Refer to the authentication section for details on how to obtain your API credentials.

Request Interface (Example - GET Method)

When making a GET request, use the following format:

const obj = {
  attributes: [],
  includes: {
    key1: [],
    key2: []
  },
  filters: { },
  sort: null,
  count: true,
  limit: 15,
  page: 1,
  search: null
}

Details of Keys:

  • attributes: List of desired attributes.
  • includes: Additional relationships to include.
  • filters: Filtering criteria.
  • sort: Sorting field.
  • count: Include total count in the response.
  • limit: Maximum number of resources.
  • page: Page number for pagination.
  • search: Search term.

Webhook Events

Event Subscriptions:

Configure webhooks to receive real-time notifications of system events, enabling automated and synchronized responses to updates within Softruck’s services.

This documentation provides a complete overview of available endpoints in the Softruck API, ensuring integrators have the resources to manage vehicles, tracking, devices, and more effectively.

auth

Login Users

Returns the user basic data and a valid authentication token

Authorizations:
bearerAuth
header Parameters
public-key
string
Example: {{public-key}}
Request Body schema: application/json
username
required
string <= 255 characters
password
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "username": "username123",
  • "password": "password123"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Refresh a valid auth token

Refresh a valid auth token using the refresh token

Authorizations:
bearerAuth
header Parameters
public-key
string
Example: {{public-key}}
Request Body schema: application/json
auth_token
required
string <= 500 characters
refresh_token
required
string <= 500 characters

Responses

Request samples

Content type
application/json
{
  • "auth_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOiJuYU9aVk0yN01SV2s5QksiLCJlaWQiOiIzeE4yWnFFUjl2OERHNVAiLCJjaWQiOiJsRzFLeERXbjNxMHdhbzgiLCJ1dHAiOiJBRE1JTiIsImFpZCI6IkcxS3hEV25KT0RXMHdhbyIsImV4cCI6MTcxMDUwOTY4OCwiaWF0IjoxNzA5OTA0ODg4fQ.Pb3wg2KFPYbm8MHCXBtWuzfl8xwr_WrVZAXtov2XIlI",
  • "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOiJuYU9aVk0yN01SV2s5QksiLCJjaWQiOiJsRzFLeERXbjNxMHdhbzgiLCJleHAiOjE3MjA0NDU2ODgsImFpZCI6IkcxS3hEV25KT0RXMHdhbyIsImVpZCI6IjN4TjJacUVSOXY4REc1UCIsImlhdCI6MTcwOTkwNDg4OH0.1fofVeE2Cxcs14ledaquQzj1BRNzicajgu-9A1D7sSs"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

users

Activate / Deactivate user

Activates or deactivates user with id provided. Return none if success

Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
Example: mkEoeqNKBvOPDJd
situation
string
Enum: "activation" "deactivation"
header Parameters
public-key
string
Example: {{public-key}}

Responses

Retrieve user details by id

Fetches detailed information about a specific user, including attributes and related entities, based on the provided user id.

Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
Example: mkEoeqNKBvOPDJd
query Parameters
attributes
Array of strings
Items Enum: "username" "email" "name" "phone1" "phone2" "emergency_contact" "emergency_phone" "document_number" "cpf" "birthdate" "created_at" "updated_at" "deactivated_at" "locale"
object
header Parameters
public-key
string
Example: {{public-key}}

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete user

Removes a user. This action is permanent and cannot be undone.

Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
Example: mkEoeqNKBvOPDJd
header Parameters
public-key
string
Example: {{public-key}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
text/plain
Update user Information 
Updates specific attributes of a user based on the user id


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
required
object
 
required
object
 
username
string  [ 1 .. 255 ] characters 
 
email
string <email>   [ 1 .. 255 ] characters 
 
name
string  <= 255 characters 
 
phone1
string or null  <= 20 characters 
 
phone2
string or null  <= 20 characters 
 
emergency_contact
string or null  <= 255 characters 
 
emergency_phone
string or null  <= 20 characters 
 
document_number
string or null  <= 20 characters 
 
cpf
string  [ 1 .. 20 ] characters 
 
birthdate
string or null <date-time> 
 
locale
string
 Enum: "pt_BR" "es_UY" "en_US" 
 
object
 
object
 
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
List all users 
Retrieves a list of users with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
query Parameters
attributes
Array of strings
Items Enum: "username" "email" "name" "phone1" "phone2" "emergency_contact" "emergency_phone" "document_number" "cpf" "birthdate" "created_at" "updated_at" "deactivated_at" "locale" 
 
object
 
object
 
search
string  <= 100 characters 
 
limit
number <float>   <= 100 
 
page
number <float> 
 
count
boolean
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Add new users 
Creates one or more users entries with attributes and related information. Returns the newly created users.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
required
object
 
username
required
string  [ 1 .. 255 ] characters 
 
email
required
string <email>   [ 1 .. 255 ] characters 
 
name
required
string  <= 255 characters 
 
phone1
string  <= 20 characters 
 
phone2
string  <= 20 characters 
 
emergency_contact
string  <= 255 characters 
 
emergency_phone
string  <= 20 characters 
 
document_number
string  <= 20 characters 
 
cpf
required
string  [ 1 .. 20 ] characters 
 
birthdate
string <date-time> 
 
locale
required
string
 Enum: "pt_BR" "es_UY" "en_US" 
 
required
object
 
required
object
 
required
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
roles
Retrieve user role details by id 
Fetches detailed information about a specific user role, including attributes and related entities, based on the provided user role id.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
attributes
Array of strings
Items Value: "name" 
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
List all user roles 
Retrieves a list of user roles with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
query Parameters
attributes
Array of strings
Items Value: "name" 
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
vehicles
Activate / Deactivate vehicle 
Activates or deactivates vehicle with id provided. Return none if success


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
situation
string
 Enum: "activation" "deactivation" 
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
Retrieve vehicle details by id 
Fetches detailed information about a specific vehicle, including attributes and related entities, based on the provided vehicle id.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
attributes
Array of strings
Items Enum: "batch" "plate" "code" "vin" "type" "brand" "model" "year" "description" "registration_number" "color" "user_names" "deactivated_at" 
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
Update vehicle Information 
Updates specific attributes of a vehicle based on the vehicle id


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
object
 
plate
string or null  <= 16 characters 
 
((string or null) or string) or string
 
type
string
 Enum: "car" "utility" "van" "scooter" "motorcycle" "tricycle" "quadricycle" "pickup truck" "truck" "bus" "micro bus" "other" "implement" "agricultural machine" "tractor truck" "tractor" 
 
code
string or null  <= 16 characters 
 
brand
string or null  <= 20 characters 
 
model
string or null  <= 20 characters 
 
year
string or null  <= 10 characters 
 
description
string or null  <= 20 characters 
 
color
string or null  <= 7 characters 
 Enum: "#FF9800" "#FF5722" "#795548" "#9E9E9E" "#8BC34A" "#2196F3" "#FFC107" "#FFEB3B" "#FFFFFF" "#9C27B0" "#C2185B" "#212121" "#F8BBD0" "#E1C699" 
 
batch
string  <= 20 characters 
 
registration_number
string or null  <= 20 characters 
 
required
object
 
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
List all vehicles 
Retrieves a list of vehicles with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
query Parameters
attributes
Array of strings
Items Enum: "batch" "plate" "code" "vin" "type" "brand" "model" "year" "description" "registration_number" "color" "user_names" "deactivated_at" 
 
object
 
object
 
search
string  <= 100 characters 
 
limit
number <float>   <= 100 
 
page
number <float> 
 
count
boolean
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Add new vehicles 
Creates one or more vehicles entries with attributes and related information. Returns the newly created vehicles.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
Array of objects
 
 Array 
required
object
 
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": [
    ]
}
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Delete vehicles 
Removes a list of vehicles. This action is permanent and cannot be undone.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
Array of objects
 
 Array 
type
required
string
 Value: "vehicles" 
 
id
required
string^[a-zA-Z0-9]{15}$
 
Responses
 Request samples 
Content type
application/json
{
  • "data": [
    ]
}
 Response samples 
Content type
text/plain
association devices
Update association device Information 
Updates specific attributes of a association device based on the association device id


Authorizations:
bearerAuth
path Parameters
vehicle_id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
association_id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
object
 
is_main_device
boolean
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
List all association devices 
Retrieves a list of association devices with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
path Parameters
vehicle_id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
object
 
filters
object
 
limit
number <float>   <= 100 
 
page
number <float> 
 
count
boolean
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Add new association devices 
Creates one or more association devices entries with attributes and related information. Returns the newly created association devices.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
Array of objects
 
 Array 
device_id
required
string^[a-zA-Z0-9]{15}$
 
vehicle_id
required
string^[a-zA-Z0-9]{15}$
 
is_main_device
required
boolean
 
Responses
 Request samples 
Content type
application/json
{
  • "data": [
    ]
}
Delete association devices 
Removes a list of association devices. This action is permanent and cannot be undone.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
Array of objects
 
 Array 
type
required
string
 Value: "device_association" 
 
id
required
string^[a-zA-Z0-9]{15}$
 
Responses
 Request samples 
Content type
application/json
{
  • "data": [
    ]
}
association users
List all association users 
Retrieves a list of association users with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
path Parameters
vehicle_id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
object
 
filters
object
 
searchables
Array of any
 
limit
number <float>   <= 100 
 
page
number <float> 
 
count
boolean
 
sort
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Add new association users 
Creates one or more association users entries with attributes and related information. Returns the newly created association users.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
Array of objects
 
 Array 
vehicle_id
required
string^[a-zA-Z0-9]{15}$
 
user_id
required
string^[a-zA-Z0-9]{15}$
 
Responses
 Request samples 
Content type
application/json
{
  • "data": [
    ]
}
Delete association users 
Removes a list of association users. This action is permanent and cannot be undone.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
Array of objects
 
 Array 
type
required
string
 Value: "user_permission" 
 
id
required
string^[a-zA-Z0-9]{15}$
 
Responses
 Request samples 
Content type
application/json
{
  • "data": [
    ]
}
tracking
Retrieve tracking details by id 
Fetches detailed information about a specific tracking, including attributes and related entities, based on the provided tracking id.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
device_id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
object
 
format
string
 Value: "JSON" 
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
text/plain
trajectories
Retrieve trajectories data details by id 
Fetches detailed information about a specific trajectories data, including attributes and related entities, based on the provided trajectories data id.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
attributes
Array of strings
Items Enum: "SEGMENT" "DETAILED" "ALARM" "STOP" 
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
Responses
 Request samples 
Content type
application/json
{ }
 Response samples 
Content type
text/plain
Retrieve trajectory details by keys validation 
Fetches detailed information about a specific trajectory, including attributes and related entities, based on the provided trajectory id.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
object
 
object
 
object
 
searchables
Array of any
 
limit
number <float> 
 
page
number <float> 
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
text/plain
List all trajectories 
Retrieves a list of trajectories with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
path Parameters
id
string
 
query Parameters
object
 
object
 
searchables
Array of any
 
limit
number <float>   <= 100 
 
page
number <float> 
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
text/plain
devices
Activate / Deactivate device 
Activates or deactivates device with id provided. Return none if success


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
situation
string
 Enum: "activation" "deactivation" 
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
Retrieve device details by id 
Fetches detailed information about a specific device, including attributes and related entities, based on the provided device id.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
attributes
Array of strings
Items Enum: "name" "imei" "batch" "created_at" "updated_at" "code" 
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
Update device Information 
Updates specific attributes of a device based on the device id


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
required
object
 
required
object
 
name
string  <= 21 characters 
 
imei
string  <= 25 characters ^[0-9]*$
 
batch
string  <= 50 characters 
 
code
string or null  <= 20 characters 
 
required
object
 
object
 
object
 
object
 
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
List all devices 
Retrieves a list of devices with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
query Parameters
attributes
Array of strings
Items Enum: "name" "imei" "batch" "created_at" "updated_at" "code" 
 
object
 
object
 
search
string  <= 100 characters 
 
limit
number <float>   <= 100 
 
page
number <float> 
 
count
boolean
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Add new devices 
Creates one or more devices with its attributes and related information. Returns the newly created devices.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
required
Array of objects
 
 Array 
required
object
 
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": [
    ]
}
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Delete devices 
Removes a list of devices. This action is permanent and cannot be undone.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
Array of objects
 
 Array 
type
required
string
 Value: "devices" 
 
id
required
string^[a-zA-Z0-9]{15}$
 
Responses
 Request samples 
Content type
application/json
{
  • "data": [
    ]
}
chips
Retrieve chip details by id 
Fetches detailed information about a specific chip, including attributes and related entities, based on the provided chip id.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
attributes
Array of strings
Items Enum: "serial" "number" "carrier" "service_provider" "batch" 
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
Update chip Information 
Updates specific attributes of a chip based on the chip id


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
required
object
 
object
 
serial
string  <= 20 characters ^[0-9]*$
 
number
string  <= 20 characters ^[0-9]*$
 
batch
string  <= 50 characters 
 
carrier
string or null  <= 255 characters 
 
service_provider
string  <= 50 characters 
 
object
 
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
List all chips 
Retrieves a list of chips with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
query Parameters
attributes
Array of strings
Items Enum: "serial" "number" "carrier" "service_provider" "batch" 
 
object
 
object
 
search
string  <= 100 characters 
 
limit
number <float>   <= 100 
 
page
number <float> 
 
count
boolean
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Add new chips 
Creates one or more chips with its attributes and related information. Returns the newly created chips.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
Array of objects
 
 Array 
required
object
 
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": [
    ]
}
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Delete chips 
Removes a list of chips. This action is permanent and cannot be undone.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
Array of objects
 
 Array 
type
required
string
 Value: "chips" 
 
id
required
string^[a-zA-Z0-9]{15}$
 
Responses
 Request samples 
Content type
application/json
{
  • "data": [
    ]
}
enterprises
Activate / Deactivate enterprise 
Activates or deactivates enterprise with id provided. Return none if success


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
situation
string
 Enum: "activation" "deactivation" 
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
Retrieve enterprise details by id 
Fetches detailed information about a specific enterprise, including attributes and related entities, based on the provided enterprise id.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
attributes
Array of strings
Items Enum: "name" "phone1" "phone2" "email" "contact_name" "created_at" "updated_at" "deactivated_at" "cnpj" "webpage" "timezone" "assistance_emergency_tel" "theft_emergency_tel" "fantasy_name" 
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
Delete enterprise 
Removes a enterprise. This action is permanent and cannot be undone.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
Responses
 Request samples 
Content type
application/json
{ }
Update enterprise Information 
Updates specific attributes of a enterprise based on the enterprise id


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
required
object
 
name
string  <= 250 characters 
 
cnpj
string  <= 25 characters 
 
timezone
string  <= 100 characters 
 Enum: "America/Rio_Branco" "America/Sao_Paulo" "America/Porto_Velho" "America/Campo_Grande" "America/Manaus" "America/Montevideo" "America/Buenos_Aires" "America/Mendoza" "America/Punta_Arenas" "America/Santiago" "America/Cancun" "America/Mexico_City" "America/Tijuana" "America/Chihuahua" "America/Asuncion" "America/Caracas" "America/Bogota" "America/Lima" "America/Guayaquil" 
 
phone1
string or null  <= 100 characters 
 
phone2
string or null  <= 100 characters 
 
email
string or null  <= 100 characters 
 
contact_name
string or null  <= 100 characters 
 
webpage
string or null  <= 255 characters 
 
assistance_emergency_tel
string or null  <= 100 characters 
 
theft_emergency_tel
string or null  <= 100 characters 
 
fantasy_name
string or null  <= 100 characters 
 
object
 
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
List all enterprises 
Retrieves a list of enterprises with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
query Parameters
attributes
Array of strings
Items Enum: "name" "phone1" "phone2" "email" "contact_name" "created_at" "updated_at" "deactivated_at" "cnpj" "webpage" "timezone" "assistance_emergency_tel" "theft_emergency_tel" "fantasy_name" 
 
object
 
object
 
search
string  <= 100 characters 
 
limit
number <float>   <= 100 
 
page
number <float> 
 
count
boolean
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Add new enterprises 
Creates a enterprise with its attributes and related information. Returns the newly created enterprise.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
required
object
 
name
required
string  <= 250 characters 
 
cnpj
required
string  <= 25 characters 
 
timezone
required
string  <= 100 characters 
 Enum: "America/Rio_Branco" "America/Sao_Paulo" "America/Porto_Velho" "America/Campo_Grande" "America/Manaus" "America/Montevideo" "America/Buenos_Aires" "America/Mendoza" "America/Punta_Arenas" "America/Santiago" "America/Cancun" "America/Mexico_City" "America/Tijuana" "America/Chihuahua" "America/Asuncion" "America/Caracas" "America/Bogota" "America/Lima" "America/Guayaquil" 
 
phone1
string  <= 100 characters 
 
phone2
string  <= 100 characters 
 
email
string  <= 100 characters 
 
contact_name
string  <= 100 characters 
 
webpage
string  <= 255 characters 
 
assistance_emergency_tel
string  <= 100 characters 
 
theft_emergency_tel
string  <= 100 characters 
 
fantasy_name
string  <= 100 characters 
 
required
object
 
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
countries
Retrieve country details by id 
Fetches detailed information about a specific country, including attributes and related entities, based on the provided country id.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
attributes
Array of strings
Items Enum: "name" "code" "timezone" 
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
List all countries 
Retrieves a list of countries with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
query Parameters
attributes
Array of strings
Items Enum: "name" "code" "timezone" 
 
search
string  <= 100 characters 
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
service-orders
Complete / Uncomplete service order 
Completes or Uncompletes service order with id provided. Return none if success


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
action
string
 Enum: "complete" "uncomplete" 
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
 Any of 
any or null
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
Retrieve service order details by id 
Fetches detailed information about a specific service order, including attributes and related entities, based on the provided service order id.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
attributes
string
 Enum: "id" "token" "name" "notes" "description" "order" "due_date" "created_at" "updated_at" "deleted_at" "priority" "completed_at" "config" "completed" 
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
any or null
 
Responses
 Request samples 
Content type
application/json
null
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
Delete service order 
Removes a service order. This action is permanent and cannot be undone.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
any or null
 
Responses
 Request samples 
Content type
application/json
null
Update service order Information 
Updates specific attributes of a service order based on the service order id


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
required
object
 
object
 
name
string or null
 
order
number <float> 
 
notes
string or null
 
priority
string or null
 Enum: "low" "medium" "high" "max" 
 
description
string or null
 
due_date
string or null <date-time> 
 
object
 
object
 
object
 
object
 
object
 
Array of objects or null
 
Array of objects
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
List all service orders 
Retrieves a list of service orders with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
query Parameters
attributes
Array of strings
Items Enum: "name" "token" "section_name" "notes" "description" "priority" "order" "enterprise_id" "enterprise_name" "cnpj" "asset_id" "plate" "brand" "model" "trim" "year" "asset_type" "type_id" "type_name" "resource" "assignee_id" "assignee_name" "assignee_username" "assignee_phone" "completed_by_id" "completed_by_name" "completed_by_username" "completed_by_phone" "completed" "completed_at" "created_at" "updated_at" "due_date" 
 
object
 
search
string  <= 100 characters 
 
limit
number <float>   <= 100 
 
page
number <float> 
 
count
boolean
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Add new task type 
Creates task type with its attributes and related information. Returns the newly created task type.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
required
object
 
required
object
 
name
string
 
order
number <float> 
 
notes
string
 
priority
string
 Enum: "low" "medium" "high" "max" 
 
description
string
 
due_date
string <date-time> 
 
object
 
required
object
 
required
object
 
required
object
 
required
object
 
object
 
object
 
object
 
Array of objects
 
Array of objects  <= 1 items 
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
acknowledgements
Retrieve task acknowledgement details by id 
Fetches detailed information about a specific task acknowledgement, including attributes and related entities, based on the provided acknowledgment id.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
acknowledgement_id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
attributes
Array of strings
Items Enum: "id" "acknowledger" "created_at" "acknowledged" "acknowledged_at" "should_rate" "rate" "ip" "user_agent" "geom" "location" 
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
Update task acknowledgement Information 
Updates specific attributes of a task acknowledgement based on the task acknowledgement id


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
acknowledgement_id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
required
object
 
required
object
 
acknowledged
required
boolean
 
rate
integer  >= 0 
 
claims
Array of strings or null
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
List all task acknowledgements 
Retrieves a list of task acknowledgements with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
attributes
Array of strings
Items Enum: "id" "acknowledger" "created_at" "acknowledged" "acknowledged_at" "should_rate" "rate" "ip" "user_agent" "geom" "location" 
 
object
 
object
 
search
string  <= 100 characters 
 
limit
number <float>   <= 100 
 
page
number <float>   >= 1 
 
count
boolean
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Add new task acknowledgement 
Creates a task acknowledgement with its attributes and related information. Returns the newly created service order.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
required
object
 
object
 
required
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
Delete task acknowledgements 
Removes a list of task acknowledgements. This action is permanent and cannot be undone.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
required
Array of objects
 
 Array 
type
required
string
 Value: "task_acknowledgements" 
 
id
required
string^[a-zA-Z0-9]{15}$
 
Responses
 Request samples 
Content type
application/json
{
  • "data": [
    ]
}
custom-fields
Update custom field value 
Updates a value of a custom field based on the custom field id


Authorizations:
bearerAuth
path Parameters
custom_field_id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
task_id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
object
 
value
string
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
Update custom field Information 
Updates specific attributes of a custom field based on the task id


Authorizations:
bearerAuth
path Parameters
custom_field_id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
task_id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
object
 
name
required
string  <= 255 characters 
 
field_format
required
string  <= 255 characters 
 
regex
string  <= 255 characters 
 
min_length
number <float> 
 
max_length
number <float> 
 
possible_values
Array of strings[ items  <= 255 characters  ]
 
is_required
boolean
 
order
number <float> 
 
cluster
string  <= 255 characters 
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
List all custom fields 
Retrieves a list of custom fields with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
path Parameters
task_id
string
 
query Parameters
attributes
Array of strings
Items Enum: "name" "field_format" "regex" "min_length" "max_length" "possible_values" "is_required" "order" "cluster" "value" "created_at" "updated_at" 
 
object
 
search
string  <= 100 characters 
 
limit
number <float>   <= 100 
 
page
number <float>   >= 1 
 
count
boolean
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Add new custom field 
Creates one or more custom fields with its attributes and related information. Returns the newly created acknowledgement.


Authorizations:
bearerAuth
path Parameters
task_id
string
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
Array of objects
 
 Array 
required
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": [
    ]
}
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Delete custom fields 
Removes a list of custom fields. This action is permanent and cannot be undone.


Authorizations:
bearerAuth
path Parameters
task_id
string
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
Array of objects
 
 Array 
type
required
string
 Value: "task_custom_fields" 
 
id
required
string^[a-zA-Z0-9]{15}$
 
Responses
 Request samples 
Content type
application/json
{
  • "data": [
    ]
}
documents
List all documents 
Retrieves a list of documents with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
attributes
Array of strings
Items Enum: "key_name" "name" "folder" "mime" "created_at" "updated_at" "file_size" 
 
object
 
limit
number <float>   <= 100 
 
page
number <float>   >= 1 
 
count
boolean
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
Responses
 Request samples 
Content type
application/json
{ }
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
sections
Retrieve task section details by id 
Fetches detailed information about a specific task section, including attributes and related entities, based on the provided task section id.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
attributes
Array of strings
Items Enum: "name" "order" "resource" "created_at" "updated_at" "deleted_at" 
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
Delete task section 
Removes a task section. This action is permanent and cannot be undone.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
any or null
 
Responses
 Request samples 
Content type
application/json
null
 Response samples 
Content type
text/plain
Update task section Information 
Updates specific attributes of a task section based on the task section id


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
required
object
 
object
 
name
string or null
 
order
number or null <float> 
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "message": "Section updated successfully"
}
List all task sections 
Retrieves a list of task sections with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
query Parameters
attributes
Array of strings
Items Enum: "name" "order" "resource" "created_at" "updated_at" "deleted_at" 
 
object
 
object
 
search
string  <= 100 characters 
 
limit
number <float>   <= 100 
 
page
number <float> 
 
count
boolean
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
Responses
 Request samples 
Content type
application/json
{ }
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Add new task section 
Creates a task section with its attributes and related information. Returns the newly created task section.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
required
object
 
required
object
 
name
string
 
order
number <float> 
 
required
object
 
required
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
types
Retrieve task type details by id 
Fetches detailed information about a specific task type, including attributes and related entities, based on the provided task type id.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
attributes
Array of strings
Items Enum: "name" "order" "resource" "created_at" "updated_at" "deleted_at" 
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
Delete task type 
Removes a list of task type. This action is permanent and cannot be undone.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
any or null
 
Responses
 Request samples 
Content type
application/json
null
 Response samples 
Content type
text/plain
Update task type Information 
Updates specific attributes of a type based on the task type id


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
required
object
 
object
 
name
string or null
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
List all task types 
Retrieves a list of task types with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
query Parameters
attributes
Array of strings
Items Enum: "name" "resource" "created_at" "updated_at" "deleted_at" 
 
object
 
object
 
search
string  <= 100 characters 
 
limit
number <float>   <= 100 
 
page
number <float> 
 
count
boolean
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
Responses
 Request samples 
Content type
application/json
{ }
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Add new task type 
Creates task type with its attributes and related information. Returns the newly created service order.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
required
object
 
required
object
 
name
string
 
required
object
 
required
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
sharings
Activate / Deactivate sharing 
Activates or deactivates sharing with id provided. Return none if success


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
situation
string
 Enum: "activation" "deactivation" 
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
Retrieve sharing details by id 
Fetches detailed information about a specific sharing, including attributes and related entities, based on the provided sharing id.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
query Parameters
attributes
Array of strings
Items Enum: "hash" "type" "valid_until" "description" "source" "resources" "tokens_generated" "deactivated_at" "created_at" "updated_at" 
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
Delete sharings 
Removes a sharing. This action is permanent and cannot be undone.


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
Responses
 Request samples 
Content type
application/json
{ }
Update sharing Information 
Updates specific attributes of a sharing based on the sharing id


Authorizations:
bearerAuth
path Parameters
id
string^[a-zA-Z0-9]{15}$
 
 Example:  mkEoeqNKBvOPDJd
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
object
 
valid_until
string <date-time> 
 
description
string or null  <= 255 characters 
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
List all sharings 
Retrieves a list of sharings with optional filters for attributes, relationships, and pagination parameters for efficient data handling.


Authorizations:
bearerAuth
query Parameters
attributes
Array of strings
Items Enum: "hash" "type" "valid_until" "description" "source" "resources" "tokens_generated" "deactivated_at" "created_at" "updated_at" 
 
object
 
object
 
search
string  <= 100 characters 
 
limit
number <float>   <= 100 
 
page
number <float>   >= 1 
 
count
boolean
 
object
 
header Parameters
public-key
string
 
 Example:  {{public-key}}
Responses
 Response samples 
Content type
application/json
{
  • "data": [
    ]
}
Add new sharings 
Creates a sharing entry with attributes and related information. Returns the newly created sharing.


Authorizations:
bearerAuth
header Parameters
public-key
string
 
 Example:  {{public-key}}
Request Body schema: application/json
object
 
required
object
 
type
required
string
 Value: "live-location" 
 
valid_until
required
string <date-time> 
 
resources
Array of strings[ items  <= 100 characters  ]
Items Enum: "enterprise" "chip" "asset" "history" "user" 
 
description
string  <= 255 characters 
 
object
 
required
object
 
required
object
 
Responses
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
 Response samples 
Content type
application/json
{
  • "data": {
    }
}
service-orders-events
Service order  Webhook 
Events triggered when a service order is updated or deleted


Authorizations:
bearerAuth
Request Body schema: application/json
The payload event sent to the url registered on webhook


object
 
type
string
 Enum: "TASKS.UPDATED" "TASKS.DELETED" 
 
platform
string
 Value: "WEBHOOK" 
 
object
 
id
string
 
enterprise_id
string
 
asset_id
string
 
type_id
string
 
task_parent_id
string
 
token
string
 
name
string
 
notes
string
 
description
string
 
order
number
 
due_date
date
 
object
 
created_at
date
 
updated_at
date
 
deleted_at
date
 
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
Provider  Webhook 
Events triggered when a service order's provider is updated or deleted


Authorizations:
bearerAuth
Request Body schema: application/json
The payload event sent to the url registered on webhook


object
 
type
string
 Enum: "TASKS.ASSIGNEE_UPDATED" "TASKS.ASSIGNEE_DELETED" 
 
platform
string
 Value: "WEBHOOK" 
 
object
 
id
string
 
task_id
string
 
assignee_id
string
 
created_at
date
 
updated_at
date
 
deleted_at
date
 
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
Section  Webhook 
Events triggered when a service order's section is updated or deleted


Authorizations:
bearerAuth
Request Body schema: application/json
The payload event sent to the url registered on webhook


object
 
type
string
 Enum: "TASKS.SECTION_UPDATED" "TASKS.SECTION_DELETED" 
 
platform
string
 Value: "WEBHOOK" 
 
object
 
id
string
 
task_id
string
 
section_id
string
 
user_id
string
 
created_at
date
 
updated_at
date
 
deleted_at
date
 
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
Custom fields  Webhook 
Events triggered when a service order's custom field is updated or deleted


Authorizations:
bearerAuth
Request Body schema: application/json
The payload event sent to the url registered on webhook


object
 
type
string
 Enum: "TASKS.CUSTOM_FIELDS_UPDATED" "TASKS.CUSTOM_FIELDS_DELETED" 
 
platform
string
 Value: "WEBHOOK" 
 
object
 
id
string
 
task_id
string
 
name
string
 
field_format
string
 Enum: "enum" "text" "number" "date" "checkbox" 
 
regex
string
 
min_length
number
 
max_length
number
 
possible_values
Array of arrays
 
is_required
boolean
 
order
number
 
value
string
 
created_at
date
 
updated_at
date
 
deleted_at
date
 
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
Completion  Webhook 
Events triggered when a service order is completed or uncompleted


Authorizations:
bearerAuth
Request Body schema: application/json
The payload event sent to the url registered on webhook


object
 
type
string
 Enum: "TASKS.COMPLETED" "TASKS.UNCOMPLETED" 
 
platform
string
 Value: "WEBHOOK" 
 
object
 
id
string
 
task_id
string
 
completed_by_id
string
 
completed_at
date
 
created_at
date
 
updated_at
date
 
deleted_at
date
 
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
Acknowledgement  Webhook 
Events triggered when a service order is acknowledged


Authorizations:
bearerAuth
Request Body schema: application/json
The payload event sent to the url registered on webhook


object
 
type
string
 Enum: "TASKS.ACKNOWLEDGEMENT_UPDATED" "TASKS.ACKNOWLEDGEMENT_DELETED" 
 
platform
string
 Value: "WEBHOOK" 
 
object
 
id
string
 
task_id
string
 
acknowledger_id
string
 
request_id
string
 
acknowledged
boolean
 
acknowledged_at
date
 
should_rate
boolean
 
rate
number
 
claims
Array of arrays
 
ip
string
 
user_agent
string
 
geom
Array of arrays
 
object
 
created_at
date
 
updated_at
date
 
deleted_at
date
 
 Request samples 
Content type
application/json
{
  • "data": {
    }
}
device-events
Device association  Webhook 
Events triggered when a device is associated to a vehicle


Authorizations:
bearerAuth
Request Body schema: application/json
The payload event sent to the url registered on webhook


object
 
type
string
 Enum: "DEVICES.ASSOCIATED" "DEVICES.ASSOCIATION_UPDATED" "DEVICES.DISASSOCIATED" 
 
platform
string
 Value: "WEBHOOK" 
 
object
 
id
string
 
uuid
string
 
device_id
string
 
asset_id
string
 
enterprise_id
string
 
is_main_device
boolean
 
input_profile
object
 
output_profile
object
 
behavior_config_id
string
 
snoozed_until
date
 
snoozed_tags
Array of arrays
 
created_at
date
 
updated_at
date
 
deleted_at
date
 
 Request samples 
Content type
application/json
{
  • "data": {
    }
}