SysAid

App · 20 actions

Manage SysAid service records, companies and assets, look up staff, and watch new or changed records.

Actions

ActionWhat it does
Create assetCreate asset.
Create companyCreate company.
Create service recordCreate service record.
Delete assetDelete asset.
Delete companyDelete company.
Delete service recordDelete service record.
Get agentGet agent.
Get assetGet asset.
Get companyGet company.
Get end userGet end user.
Get service recordGet service record.
List agentsList agents.
List assetsList assets.
List companiesList companies.
List end usersList end users.
List groupsList groups.
List service recordsList service records.
Update assetUpdate asset.
Update companyUpdate company.
Update service recordUpdate service record.

Create asset

Create asset.

Inputs

NamenametextRequired
The name of the asset.
TypetypetextRequired
The asset type (Laptop / Smartphone / etc.).
Sourcesourcetext
The origin of the asset, describing how it was added to the system.
Manufacturermanufacturertext
The manufacturer of the asset.
Modelmodeltext
The model of the asset.
Serialserialtext
The asset's serial number according to the manufacturer.
Descriptiondescriptiontext
The description of the asset.
Is disabledis_disabledtrue/false
Indicates whether the asset is disabled. When true, automatic inventory updates, monitoring, and all other SysAid Agent capabilities are turned off for the asset.
Owner IDowner_idnumber
The unique ID of the user who owns the asset.
Ownershipownershiptext
Defines who is the official owner of the asset - the employee or the company.One of: personal, company.
Companycompany_idnumber
The unique ID of the company the asset belongs to.
Location IDlocation_idnumber
The unique ID of the asset’s location.
Department IDdepartment_idnumber
The unique ID of the department the asset belongs to.
Warranty expirationwarranty_expirationdate
The date when the asset’s warranty expires.
Patch management enabledpatch_management_enabledtrue/false
Indicates if patch management is enabled for the asset. To learn more, see SysAid Patch Management Guide.
Ososobject
Operating System properties.
Networknetworkobject
Network properties.
Custom fieldscustom_fieldsobject
Custom fields.
Additional dataadditional_datatext
Additional data available for the asset.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": "MSI-123",
    "success": true
  }
}

Create company

Create company.

Inputs

NamenametextRequired
Name.
Addressaddresstext
Main company address.
Address2address2text
Additional company address.
Citycitytext
The city in which the company is located.
Statestatetext
The state in which the company is located.
Zipziptext
The company's zip code.
Countrycountrytext
The country in which the company is located.
Phonephonetext
The company’s phone number.
Faxfaxtext
The company’s fax number.
Notesnotestext
Notes related to the company.
Email accountemail_accounttext
Default email account.
Expiration dateexpiration_datedate
The date when the company's access to the help will expire.
Agreement IDagreement_idnumber
The ID of the SLA applied to the company.
Agreement start dateagreement_start_datedate
The start date of your service agreement with the company.
Agreement end dateagreement_end_datedate
The end date of your service agreement with the company.
Custom fieldscustom_fieldsobject
Company custom fields.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": 100
  }
}

Create service record

Create service record.

Inputs

Template IDtemplate_idnumber
Template ID.
TypetypetextRequired
Type.One of: incident, problem, request, change.
Change categorychange_categorynumber
The classification or severity level id of the service record (relevant only for service requests of Change type and depends on the account).
Descriptiondescriptiontext
A detailed description of the service record.
Due datedue_datedate and time
The date by which the service record is expected to be resolved.
Impactimpactnumber
The impact level of the service record, indicating its effect on operations.
Assetasset_idtext
The primary asset id associated with the service record.
Ci IDci_idnumber
The main configuration item (CI) id related to the service record.
Priorityprioritynumber
The priority id level of the service record.
Statusstatusnumber
The current status id of the service record (e.g., Open, Closed, Pending). Depends on an account.
TitletitletextRequired
The title or subject of the service record.
Urgencyurgencynumber
The urgency level of the service record, indicating how quickly it should be addressed.
Weightweightnumber
A numerical value that may indicate the relative importance or complexity of the service record.
Sr sub typesr_sub_typenumber
Service record subtype.
Locationlocationnumber
Unique id of the location associated with the service record.
Cust int1cust_int1number
Custom value 1.
Cust int2cust_int2number
Custom value 1.
Cust date1cust_date1date and time
Custom date 1.
Cust date2cust_date2date and time
Custom date 1.
Cust notescust_notestext
Custom notes.
Cust text1cust_text1text
Custom text 1.
Cust text2cust_text2text
Custom text 2.
Cust list1cust_list1number
Custom list 1 integer identifier.
Cust list2cust_list2number
Custom list 1 integer identifier.
Parent linkparent_linknumber
Parent link.
Workaroundworkaroundtext
Workaround.
Task IDtask_idnumber
Task ID.
Project IDproject_idnumber
Project ID.
Versionversionnumber
Version.
Success ratingsuccess_ratingnumber
Success rating.
Followup textfollowup_texttext
Followup text.
Followup actual datefollowup_actual_datedate and time
Followup actual date.
Followup planned datefollowup_planned_datedate and time
Followup planned date.
Cccctext
Cc.
Primary categoryprimary_categorynumber
First level service record category id.
Secondary categorysecondary_categorynumber
Second level service record category id.
Third level categorythird_level_categorynumber
Third level service record category id.
Assigned groupassigned_grouptext
Name of the administrative group responsible for managing the service record.
Assigneeassigneetext
Username of the user to whom the service record is assigned.
Request userrequest_usertext
Username of the user who originally requested the service record.
Followup userfollowup_usertext
Username of the user who follows up the service record's changes.
Responsible managerresponsible_managertext
Admin username who manages the service record.
Custom columns fieldscustom_columns_fieldsobject
Custom columns fields.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": 1779,
    "version": 1
  }
}

Delete asset

Delete asset.

Inputs

IdidtextRequired
The unique identifier of the asset in SysAid.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Delete company

Delete company.

Inputs

Companycompany_idnumberRequired
The unique identifier of the company in SysAid.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Delete service record

Delete service record.

Inputs

Recordrecord_idnumberRequired
The service record's unique SysAid ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Get agent

Get agent.

Inputs

IdidnumberRequired
The agent's unique SysAid ID.
Expandexpandlist
Include additional related data in the response for the selected entity/entities.One or more of: groups, company.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": 342,
    "version": 13
  }
}

Get asset

Get asset.

Inputs

IdidtextRequired
The unique identifier of the asset in SysAid.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": "MSI-123",
    "name": "KATANA-GF66",
    "version": 1
  }
}

Get company

Get company.

Inputs

Companycompany_idnumberRequired
The unique identifier of the company in SysAid.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": 1,
    "name": "Alpha",
    "version": 5
  }
}

Get end user

Get end user.

Inputs

IdidnumberRequired
The end user's unique SysAid ID.
Expandexpandlist
Include additional related data in the response for the selected entity/entities.One or more of: groups, company.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": 342,
    "version": 13
  }
}

Get service record

Get service record.

Inputs

Recordrecord_idnumberRequired
The unique ID of the service record
Fieldsfieldslist
A comma-separated list of service record fields to return in response.
Expandexpandlist
Names of service record property to expandOne or more of: company, requestUser, ci, asset, category.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": 1779,
    "version": 1
  }
}

List agents

List agents.

Inputs

Limitlimitnumber
The numbder of items to display per page. The deafult is 20 and you can have up to 500.From 1 to 500.
Offsetoffsetnumber
The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1).At least 0.
Queryquerytext
Query to search by username, first name, last name, email or phone.
Expandexpandlist
Include additional related data in the response for the selected entity/entities.One or more of: groups, company.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": []
  }
}

List assets

List assets.

Inputs

Limitlimitnumber
The number of records to return per page, up to 500.From 1 to 500.
Offsetoffsetnumber
The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1).At least 0.
Sort bysort_bytext
An asset field to sort by.One of: id, name, type, manufacturer, model, serial, ownerId, source, ownership, companyId, and 4 more.
Sort dirsort_dirtext
Assets sorting direction.One of: asc, desc.
Queryquerytext
A string by which assets are searched. The search is made in the following asset properties: name, description and additionalData.
Ididlist
Assets id filter.
Sourcesourcelist
Assets source filter.
Ownershipownershiplist
Assets ownership filterOne or more of: personal, company, none.
Is disabledis_disabledtrue/false
Assets disablement status filter.
Owner IDowner_idlist
Assets owner ids filter.
Namenametext
Assets name filter.
Typetypetext
Assets type filter.
Descriptiondescriptiontext
Assets description filter.
Ip addressesip_addressestext
Assets IP addresses filter.
Mac addressesmac_addressestext
Assets MAC addresses filter
Manufacturermanufacturertext
Assets manufacturer name filter.
Modelmodeltext
Assets model name filter.
Serialserialtext
Assets model name filter.
Companycompany_idlist
Assets company id filter.
Department IDdepartment_idlist
Assets department id filter.
Location IDlocation_idlist
Assets location id filter.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": []
  }
}

List companies

List companies.

Inputs

Limitlimitnumber
The number of items to display per page. The default is 100, and you can have up to 500.From 1 to 500.
Offsetoffsetnumber
The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1).At least 0.
Queryquerytext
The string by which to search companies.
Namenametext
The name (partial or whole) companies filter.
Ididlist
The ID companies filter.
Statestatetext
The state (partial or whole) companies filter.
Citycitytext
The city (partial or whole) companies filter.
Countrycountrytext
The country (partial or whole) companies filter.
Addressaddresstext
The address (partial or whole) companies filter.
Agreement IDagreement_idlist
The agreement ID companies filter.
Sort bysort_bytext
The property by which companies are sorted.One of: id, name, address, address2, city, state, country, zip, phone, fax, and 5 more.
Sort dirsort_dirtext
The direction in which companies are sorted.One of: asc, desc.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": []
  }
}

List end users

List end users.

Inputs

Limitlimitnumber
The numbder of items to display per page. The deafult is 20 and you can have up to 500.From 1 to 500.
Offsetoffsetnumber
The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1).At least 0.
Queryquerytext
Query to search by username, first name, last name, email or phone.
Expandexpandlist
Include additional related data in the response for the selected entity/entities.One or more of: groups, company.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": []
  }
}

List groups

List groups.

Inputs

Limitlimitnumber
The numbder of items to display per page. The deafult is 20 and you can have up to 500.From 1 to 500.
Offsetoffsetnumber
The offset for pagination. Calculated as `(page - 1) * limit` (page starts at 1).At least 0.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": []
  }
}

List service records

List service records.

Inputs

Fieldsfieldslist
A comma-separated list of fields to return in service records.
Queryquerytext
The search criteria
Offsetoffsetnumber
SR count is limited (see limit parameter). This parameter specifies the offset (start point) from which to retrieve values (e.g. 25). Defaults to 0.
Limitlimitnumber
The maximum number of SRs to retrieve per request. Defaults to 100 results (configurable).At most 100.
Sort bysort_bylist
One or more fields to sort by. Available fields are those that were fetched by the request.
Sort dirsort_dirtext
Sort order: ascending or descending. Available values: asc/desc. Default is 'asc'. Relevant only when sort parameter is sent.One of: asc, desc.
Expandexpandlist
Names of service record property to expandOne or more of: company, requestUser, ci, asset, category.
Filtersfiltersobject
List of key-value parameters with {filter.id} as the key. and {filter.values.id} as the value. I.e.: …&status=19&request_user=235. Multiple values can be sent, comma-separated. I.e.: …&status=4,5.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": []
  }
}

Update asset

Update asset.

Inputs

IdidtextRequired
The unique identifier of the asset in SysAid.
Namenametext
The name of the asset.
Typetypetext
The asset type (Laptop / Smartphone / etc.).
Sourcesourcetext
The origin of the asset, describing how it was added to the system.
Manufacturermanufacturertext
The manufacturer of the asset.
Modelmodeltext
The model of the asset.
Serialserialtext
The asset's serial number according to the manufacturer.
Descriptiondescriptiontext
The description of the asset.
Is disabledis_disabledtrue/false
Indicates whether the asset is disabled. When true, automatic inventory updates, monitoring, and all other SysAid Agent capabilities are turned off for the asset.
Owner IDowner_idnumber
The unique ID of the user who owns the asset.
Ownershipownershiptext
Defines who is the official owner of the asset - the employee or the company.One of: personal, company.
Companycompany_idnumber
The unique ID of the company the asset belongs to.
Location IDlocation_idnumber
The unique ID of the asset’s location.
Department IDdepartment_idnumber
The unique ID of the department the asset belongs to.
Warranty expirationwarranty_expirationdate
The date when the asset’s warranty expires.
Patch management enabledpatch_management_enabledtrue/false
Indicates if patch management is enabled for the asset. To learn more, see SysAid Patch Management Guide.
Ososobject
Operating System properties.
Networknetworkobject
Network properties.
Custom fieldscustom_fieldsobject
Custom fields.
Additional dataadditional_datatext
Additional data available for the asset.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "success": true
  }
}

Update company

Update company.

Inputs

Companycompany_idnumberRequired
The unique identifier of the company in SysAid.
Namenametext
Name.
Addressaddresstext
Main company address.
Address2address2text
Additional company address.
Citycitytext
The city in which the company is located.
Statestatetext
The state in which the company is located.
Zipziptext
The company's zip code.
Countrycountrytext
The country in which the company is located.
Phonephonetext
The company’s phone number.
Faxfaxtext
The company’s fax number.
Notesnotestext
Notes related to the company.
Email accountemail_accounttext
Default email account.
Expiration dateexpiration_datedate
The date when the company's access to the help will expire.
Agreement IDagreement_idnumber
The ID of the SLA applied to the company.
Agreement start dateagreement_start_datedate
The start date of your service agreement with the company.
Agreement end dateagreement_end_datedate
The end date of your service agreement with the company.
Custom fieldscustom_fieldsobject
Company custom fields.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": 1,
    "name": "Alpha",
    "version": 5
  }
}

Update service record

Update service record.

Inputs

Recordrecord_idnumberRequired
The service record's unique SysAid ID.
Change categorychange_categorynumber
The classification or severity level id of the service record (relevant only for service requests of Change type and depends on the account).
Descriptiondescriptiontext
A detailed description of the service record.
Due datedue_datedate and time
The date by which the service record is expected to be resolved.
Impactimpactnumber
The impact level of the service record, indicating its effect on operations.
Assetasset_idtext
The primary asset id associated with the service record.
Ci IDci_idnumber
The main configuration item (CI) id related to the service record.
Priorityprioritynumber
The priority id level of the service record.
Statusstatusnumber
The current status id of the service record (e.g., Open, Closed, Pending). Depends on an account.
Titletitletext
The title or subject of the service record.
Urgencyurgencynumber
The urgency level of the service record, indicating how quickly it should be addressed.
Weightweightnumber
A numerical value that may indicate the relative importance or complexity of the service record.
Sr sub typesr_sub_typenumber
Service record subtype.
Locationlocationnumber
Unique id of the location associated with the service record.
Cust int1cust_int1number
Custom value 1.
Cust int2cust_int2number
Custom value 1.
Cust date1cust_date1date and time
Custom date 1.
Cust date2cust_date2date and time
Custom date 1.
Cust notescust_notestext
Custom notes.
Cust text1cust_text1text
Custom text 1.
Cust text2cust_text2text
Custom text 2.
Cust list1cust_list1number
Custom list 1 integer identifier.
Cust list2cust_list2number
Custom list 1 integer identifier.
Parent linkparent_linknumber
Parent link.
Workaroundworkaroundtext
Workaround.
Task IDtask_idnumber
Task ID.
Project IDproject_idnumber
Project ID.
Success ratingsuccess_ratingnumber
Success rating.
Followup textfollowup_texttext
Followup text.
Followup actual datefollowup_actual_datedate and time
Followup actual date.
Followup planned datefollowup_planned_datedate and time
Followup planned date.
Cccctext
Cc.
Primary categoryprimary_categorynumber
First level service record category id.
Secondary categorysecondary_categorynumber
Second level service record category id.
Third level categorythird_level_categorynumber
Third level service record category id.
Assigned groupassigned_grouptext
Name of the administrative group responsible for managing the service record.
Assigneeassigneetext
Username of the user to whom the service record is assigned.
Request userrequest_usertext
Username of the user who originally requested the service record.
Followup userfollowup_usertext
Username of the user who follows up the service record's changes.
Responsible managerresponsible_managertext
Admin username who manages the service record.
Custom columns fieldscustom_columns_fieldsobject
Custom columns fields.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": 1779,
    "version": 1
  }
}

On this page