IT Management API

Version 1.3

Reqeust Methods
Type Description Fields to send via $_ADD
get Fetch data. key [string, required] – your API Key
method [string, required] = get
resource [string, required] – see Resources table
filters [array, optional] – see resource details for filterable fields
add Add new item. key [string, required] – your API Key
method [string, required] = add
resource [string, required] – see Resources table
data [array, requires] – see resource details for field list
edit Update/Edit current key [string, required] – your API Key
data. method [string, required] = edit
resource [string, required] – see Resources table
data [array, requires] – see resource details for field list

While making a PUT request you will have to send all fields in the
data array even if only one value has changed
delete Delete one item at a key [string, required] – your API Key
time. method [string, required] = delete
resource [string, required] – see Resources table
id [integer, requires] – id of the element to be deleted

Status Codes
Code Description
901 Unknown error.
902 API key missing.
903 Authentication failed. Invalid API Key
904 Resource [resource name] does not exist.
905 You are not authorized to perform [request method] for [resource name].
906 Request method [request method] not found.
907 Request method [request method] not allowed for this resource.
908 'filters' Error! Expected array, string given.
909 'data' Error! Expected array, string given.
910 'data' array missing.
911 'id' Error! Expected string, array given.
912 'id' string missing.

1 Success!
2 Error!

Resource List

Resource Available Methods

clients get, add, edit, delete
assets get, add, edit, delete
licenses get, add, edit, delete
credentials get, add, edit, delete
asset_categories get, add, edit, delete
license_categories get, add, edit, delete
status_labels get, add, edit, delete
manufacturers get, add, edit, delete
models get, add, edit, delete
locations get, add, edit, delete
suppliers get, add, edit, delete
projects get, add, edit, delete
tickets get, add, edit, delete
ticket_replies get, add
issues get, add, edit, delete
kb_categories get, add, edit, delete
kb_articles get, add, edit, delete
monitoring_hosts get, add, edit, delete
monitoring_checks get, add, edit, delete
users get, add, edit, delete
staff get, add, edit, delete
roles get
languages get
contacts get, add, edit, delete
comments get, add, edit, delete
milestones get, add, edit, delete
predefined_replies get, add, edit, delete
custom_asset_fields get
custom_license_fields get
config get
ticket_departments get
time_log get, add, edit, delete
system_log get, add
files get, add, delete
authenticate get
Resource Details

CLIENTS
Field get add edit Notes
Usable in filters Use in data Use in data
array array array
id Yes No Yes INT 11
name Yes Yes Yes VARCHAR 255
asset_tag_prefix Yes Yes Yes VARCHAR 255
license_tag_prefix Yes Yes Yes VARCHAR 255
notes Yes Yes Yes LONGTEXT
Can be empty

ASSETS
Field get add edit Notes
Usable in filters Use in data Use in data
array array array
id Yes No Yes INT 11
categoryid Yes Yes Yes INT 11
adminid Yes Yes Yes INT 11
You may send 0
clientid Yes Yes Yes INT 11
You may send 0
userid Yes Yes Yes INT 11
You may send 0
manufacturerid Yes Yes Yes INT 11
You may send 0
modelid Yes Yes Yes INT 11
You may send 0
supplierid Yes Yes Yes INT 11
 You may send 0
statusid Yes Yes Yes INT 11
purchase_date Yes Yes Yes DATE YYYY-MM-DD
Can be 0000-00-00
warranty_months Yes Yes Yes INT 11
tag Yes Yes Yes VARCHAR 255
name Yes Yes Yes VARCHAR 255
serial Yes Yes Yes VARCHAR 255
Can be empty
notes Yes Yes Yes TEXT
Can be empty
locationid Yes Yes Yes INT 11
You may send 0
customfields No Yes Yes Array of custom
fields (see custom
fields resource)
qrvalue Yes Yes Yes TEXT
Can be empty

While adding or editing or adding an asset the following fields can be send with their names instead of
their ids, IT Management will automatically assign the id if the name is found or create a new one.

category instead of categoryid – text, a new category will be added if does not exists

manufacturer instead of manufacturerid – text, a new manufacturer will be added if does not exists

model instead of modelid – text, a new model will be added if does not exists

supplier instead of supplierid – text, a new supplier will be added if does not exists

location instead of locationid – text, a new location will be added if does not exists

Do no send, for example, location and locationid, send only one of these.

LICENSES
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
clientid Yes Yes Yes INT 11
You may send 0
statusid Yes Yes Yes INT 11
categoryid Yes Yes Yes INT 11
supplierid Yes Yes Yes INT 11
 You may send 0
seats Yes Yes Yes VARCHAR 5
tag Yes Yes Yes VARCHAR 255
name Yes Yes Yes VARCHAR 255
serial Yes Yes Yes TEXT
Can be empty
notes Yes Yes Yes TEXT
Can be empty
customfields Yes Yes Yes Array of custom
fields (see custom
fields resource)

CREDENTIALS
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
clientid Yes Yes Yes INT 11
You may send 0
assetid Yes Yes Yes INT 11
You may send 0
type Yes Yes Yes VARCHAR 255
username Yes Yes Yes VARCHAR 255
password No Yes Yes VARCHAR 255
Can be empty for
no change

ASSET_CATEGORIES
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
name Yes Yes Yes VARCHAR 255
color Yes Yes Yes VARCHAR 7
Example: #167cc1

LICENSE_CATEGORIES
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
name Yes Yes Yes VARCHAR 255
color Yes Yes Yes VARCHAR 7
 Example: #167cc1

STATUS LABELS
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
name Yes Yes Yes VARCHAR 255
color Yes Yes Yes VARCHAR 7
Example: #167cc1

MANUFACTURERS
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
name Yes Yes Yes VARCHAR 255

MODELS
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
name Yes Yes Yes VARCHAR 255

LOCATIONS
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
name Yes Yes Yes VARCHAR 255
clientid Yes Yes Yes INT 11
You may send 0

SUPPLIERS
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
name Yes Yes Yes VARCHAR 255
address Yes Yes Yes TEXT
Can be empty
contactname Yes Yes Yes VARCHAR 255
Can be empty
phone Yes Yes Yes VARCHAR 255
Can be empty
email Yes Yes Yes VARCHAR 255
Can be empty
web Yes Yes Yes VARCHAR 255
Can be empty
notes Yes Yes Yes LONGTEXT
Can be empty

PROJECTS
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
clientid Yes Yes Yes INT 11
You may send 0
tag Yes Yes Yes VARCHAR 255
name Yes Yes Yes VARCHAR 255
notes Yes Yes Yes LONGTEXT
Can be empty
description Yes Yes Yes TEXT
Can be empty
startdate Yes Yes Yes DATE YYYY-MM-DD
Can be empty
deadline Yes Yes Yes DATE YYYY-MM-DD
Can be empty
progress Yes Yes Yes INT 3
Send “-1” for auto-
progress

TICKETS
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
departmentid Yes Yes Yes INT 11
clientid Yes Yes Yes INT 11
You may send 0
adminid Yes Yes Yes INT 11
You may send 0
userid Yes No Yes INT 11
You may send 0
assetid Yes Yes Yes INT 11
You may send 0
 projectid Yes Yes Yes INT 11
You may send 0
email Yes Yes Yes VARCHAR 255
subject Yes Yes Yes VARCHAR 255
priority Yes Yes Yes Low, Normal or High
notes Yes Yes Yes TEXT
Can be empty
ccs Yes Yes Yes Array of email
addresses
Can be empty
message Yes Yes No LONGTEXT
notification No Yes No true or false
Send new ticket
notification to user
status Yes No Yes Open, In Progress,
Answered,
Reopened or Closed

TICKET_REPLIES
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No X INT 11
ticketid Yes Yes X INT 11
adminid No Yes X INT 11
You may send 0 !!!
userid No Yes X INT 11
You may send 0 !!!
message Yes Yes X LONGTEXT
peopleid Yes No X INT 11
status No Yes X Open, In Progress,
Optional Answered,
Reopened or Closed
Optional to change
the status of a ticket
after adding the
reply.

notification No Yes X true or false

Send new ticket
notification to user

!! You cannot edit or delete a ticket reply

!!! either one value of adminid or userid needs to be different then 0 so the system can correctly classify
the ticket.

ISSUES
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
clientid Yes Yes Yes INT 11
You may send 0 !!!
assetid Yes Yes Yes INT 11
You may send 0 !!!
projectid Yes Yes Yes INT 11
You may send 0 !!!
adminid Yes Yes Yes INT 11
You may send 0 !!!
issuetype Yes Yes Yes Task, Maintenance,
Bug, Improvement,
New Feature or
Story
priority Yes Yes Yes Low, Normal or High
status Yes Yes Yes To Do, In Progress,
In Review or Done
name Yes Yes Yes VARCHAR 255
description Yes Yes Yes LONGTEXT
Can be empty
duedate Yes Yes Yes DATE YYYY-MM-DD
Can be 0000-00-00

KB_CATEGORIES
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
clients No Yes Yes Array of client ids
with access to this
category, if 0 is
added as an
element to this
array all clients will
have access to this
category
name Yes Yes Yes VARCHAR 255

KB_ARTICLES
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
categoryid Yes Yes Yes INT 11
You can send 0 for
the root category
clients No Yes Yes Array of client ids
with access to this
category, if 0 is
added as an
element to this
array all clients will
have access to this
article
name Yes Yes Yes VARCHAR 255
content Yes Yes Yes LONGTEXT
Can be empty

MONITORING_HOSTS
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
clientid Yes Yes Yes INT 11
You can send 0
name Yes Yes Yes VARCHAR 255
address Yes Yes Yes VARCHAR 255
status Yes No No Up or Down
Can be empty

MONITORING_CHECKS
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
hostid Yes Yes Yes INT 11
name Yes Yes Yes
type Yes Yes Yes VARCHAR 255
Always send
“Service”
port Yes Yes Yes VARCHAR 60
monitoring Yes Yes Yes 0 or 1
email Yes Yes Yes 0 or 1
sms Yes Yes Yes 0 or 1
status Yes No No Up or Down
Can be empty
USERS
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
name Yes Yes Yes VARCHAR 255
roleid Yes Yes Yes INT 11
clientid Yes Yes Yes INT 11
email Yes Yes Yes VARCHAR 255
ldap_user Yes Yes Yes VARCHAR 255
Can be empty
title Yes Yes Yes VARCHAR 60
Can be empty
mobile Yes Yes Yes VARCHAR 255
Can be empty
password No Yes Yes VARCHAR 255
Required Send empty for
no change
notification No Yes No true or false
Send new ticket
notification to user
theme Yes No Yes skin-blue,
skin-black,
skin-purple,
skin-green,
skin-red,
skin-yellow,
skin-blue-light,
skin-black-light,
skin-purple-light,
skin-green-light,
skin-red-light,
or skin-yellow-light
sidebar Yes No Yes opened
or collapsed
layout Yes No Yes Empty for standard,
fixed or layout-
boxed
notes Yes No Yes TEXT
Can be empty
lang Yes No Yes Example: eu
Must be in the
system
fcmtoken Yes Yes Yes TEXT
Can be empty
STAFF
Field get add edit Notes
Usable in filters Use in data array Use in data
array array
id Yes No Yes INT 11
name Yes Yes VARCHAR 255
roleid Yes Yes INT 11
email Yes Yes VARCHAR 255
ldap_user Yes Yes VARCHAR 255
Can be empty
title Yes Yes VARCHAR 60
Can be empty
mobile Yes Yes VARCHAR 255
Can be empty
password No Yes Yes VARCHAR 255
Required Send empty for
no change
notification No Yes No true or false
Send new ticket
notification to user
theme Yes No Yes skin-blue,
skin-black,
skin-purple,
skin-green,
skin-red,
skin-yellow,
skin-blue-light,
skin-black-light,
skin-purple-light,
skin-green-light,
skin-red-light,
or skin-yellow-light
sidebar Yes No Yes opened
or collapsed
layout Yes No Yes Empty for standard,
fixed or layout-
boxed
notes Yes No Yes TEXT
Can be empty
lang Yes No Yes Example: eu
Must be in the
system
ticketsnotification Yes Yes Yes INT 1
0 or 1
 Receive
notifications when
new tickets are
opened or new
replies are added
from clients
fcmtoken Yes Yes Yes TEXT
Can be empty

ROLES
Field get Notes
Usable in filters array
id Yes INT 11
type Yes admin or user
name Yes VARCHAR 255
perms No Array of permissions

LANGUAGES
Field get Notes
Usable in filters array
id Yes INT 11
code Yes VARCHAR 4
name Yes VARCHAR 255

CONTACTS
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
name Yes Yes Yes VARCHAR 255
email Yes Yes Yes VARCHAR 255
phone Yes Yes Yes VARCHAR 32
Can be empty
address Yes Yes Yes TEXT
Can be empty
webaddress Yes Yes Yes TEXT
Can be empty
notes Yes Yes Yes LONGTEXT
Can be empty

COMMENTS
 Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
peopleid Yes Yes Yes INT 11
You can send 0
clientid Yes Yes Yes INT 11
You can send 0
projectid Yes Yes Yes INT 11
You can send 0
ticketid Yes Yes Yes INT 11
You can send 0
comment Yes Yes Yes LONGTEXT

!! At least one of peopleid , clientid , projected, ticketid must be different than 0 to correctly associate
the comment

MILESTONES
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
projectid Yes Yes No INT 11
name Yes Yes Yes VARCHAR 255
duedate Yes Yes Yes DATE YYYY-MM-DD
Can be empty
description Yes Yes Yes LONGTEXT
Can be empty

PREDEFINED_REPLIES
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
name Yes Yes Yes VARCHAR 255
content Yes Yes Yes LONGTEXT

CUSTOM_ASSET_FIELDS
Field get Notes
Usable in filters array
id Yes INT 11
type Yes Text Box,
Text Area
or Dropdown
name Yes VARCHAR 255
description Yes VARCHAR 255
options Yes TEXT
Comma separated
list for dropdown

CUSTOM_LICENSE_FIELDS
Field get Notes
Usable in filters array
id Yes INT 11
type Yes Text Box,
Text Area
or Dropdown
name Yes VARCHAR 255
description Yes VARCHAR 255
options Yes TEXT
Comma separated
list for dropdown

TICKET_DEPARTMENTS
Field get Notes
Usable in filters array
id Yes INT 11
name Yes VARCHAR 255
email Yes TEXT
Comma separated
list of email
addresses

CONFIG
Field get Notes
Usable in filters array
name Yes VARCHAR 128
value Yes TEXT

TIME_LOG
Field get add edit Notes
Usable in filters array Use in data array Use in data array
id Yes No Yes INT 11
staffid Yes Yes Yes INT 11
clientid Yes Yes Yes INT 11
You can send 0
projectid Yes Yes Yes INT 11
You can send 0
assetid Yes Yes Yes INT 11
You can send 0
issues Yes Yes Yes Array of issue ids
tickets Yes Yes Yes Array of tickets ids
description Yes Yes Yes TEXT
date Yes Yes Yes DATE YYYY-MM-DD
start Yes Yes Yes TIME, 24h format
HH:MM:SS
end Yes Yes Yes TIME, 24h format
HH:MM:SS

SYSTEM_LOG
Field get add Notes
Usable in filters array Use in data array
id Yes No INT 11
peopleid Yes Yes INT 11, can be
userid or adminid
description Yes Yes TEXT

FILES
Field get add Notes
Usable in filters array Use in data array
id Yes No INT 11
clientid Yes Yes INT 11
You can send 0*
projectid Yes Yes INT 11
You can send 0*
assetid Yes Yes INT 11
You can send 0*
ticketreplyid Yes Yes INT 11
You can send 0*
 name Yes Yes VARCHAR 255, if
empty file name will
be used
file No Yes ARRAY OF FILES

*Use at least one to correctly assign the file

AUTHENTICATE
Field get Notes
Usable in filters array
username Yes VARCHAR
password Yes VARCHAR

Username can be email address or LDAP username.

Notes

1. While adding new items (add) all fields marked with Yes from the ADD column must be sent
even if they are empty or 0
2. While editing items (edit) all fields marked with Yes from the PUT columns must be sent even if
they are empty, 0 or suffered no changes.
To edit an item: retrieve with get, make the required changes and then send an edit request.
3. While fetching data (get) you may send multiple filter values in the filters array or none at all to
retrieve everything.
4. All returned data from the API is in JSON format