Skip to main content

SysAid API

Write your own code to create, retrieve, update, and delete SysAid entities, integrating SysAid with your other applications.

  • 81 Posts
  • 216 Replies
81 Posts
V
VoelundurNew SysMate
asked in SysAid API
API to GET open service records by Customer ID

Looking to GET open service records filtered by Customer ID. I can’t find a dedicated endpoint for this in the API ref, e.g. Get Service Records by Customer ID.If you have found a way to do this with the new API, I’d love to see and example structure of the JSON payload sent in the request body.  Thank you

252
V
R
Community Enthusiast
rgireyevCommunity Enthusiast
asked in SysAid API
Search API Endpoint Stopped working

Hello Everyone! I’ve been using the search API endpoint in our production environment for a while, to ensure that duplicate requests do not get created. Last week though we noticed a lot of duplicates so I went looking for a reason and today discovered that the search API Endpoint stopped working. Since this is kind of urgent I’m happy to hear any and all input that anyone might have. My users are not happy at the moment. :(We use the SysAid cloud version. Here is the call:/api/v1/sr/search?query=($9335$)&fields=title Note the parenthesis and the dollar signs are part of what I’m looking for. The return for this is the following JSON:{    "status": 500,    "message": "Failed to load list of service requests"} Thank youRudy 

371
M
SysAider
H
hjacqueminNew SysMate
asked in SysAid API
Action ITEM - API - Python

Hello,I’m struggling with action item call through the API.Based on the documentation :  I tried the following API call on Postman:    The “type” is not working (even copy past from the doc) and without the type I juste have a 500 internal error from the server. ids = my request ID Can someone help me with this ?

924
H
L
liamyuenergyNew SysMate
asked in SysAid API
API for service request changes /journey

Hi,I’m new to using SysAid and currently working with the new APIs based off the documentation here developers.sysaid.com/docs/sysaid-api-overview.When exploring individual service records in our portal there is a panel labelled journey which captures the records journey/changes over time.  Interested to know if its possible to access this level of change data via api?Thanks

400
L
C
chackettNew SysMate
asked in SysAid API
Parsing Asset Data from Rest API

I am pulling asset data from SysAid Rest API into Microsoft Power Automate. I am looking for a better way to parse the data. Currently, I am having to parse the json of the output and then filter the data by each keyCaption value and append that to an array variable. For a amount of assets, currently we’re just over 1000 assets, this process can take upwards of 24 hours to collect my asset variables. Is there a better way to parse the data from the start to get the key values into usable dynamic feilds faster below is a sample of the parse json output of the data.[  {    "info": [      {        "key": "device_status",        "value": 0,        "valueClass": "",        "valueCaption": "",        "keyCaption": "Status"      },      {        "key": "account_id",        "value": "cmhcm",        "valueClass": "",        "valueCaption": "cmhcm",        "keyCaption": "Account"      },      {        "key": "serial",        "value": "",        "valueClass": "",        "valueCaption": "",       

151
SysAid Copilot
SysAider
R
Active talker
rdtjbrownActive talker
asked in SysAid API
REST API - Report retrieval?

Is it possible to use the REST API to run and retrieve a report from SysAid? 

522
simonamirza
SysAider
R
Community Enthusiast
ronentCommunity Enthusiast
asked in SysAid API
Problem uploading attachments via the SysAid REST API

Hi,We're trying to upload attachments via the SysAid REST API.It works on our local environment, but fails from our public environment with a 401 Unauthorized error.creating SR is successful.We suspect there might be IP or domain restrictions.Could you confirm if any such restrictions exist and help us to understand how to allow access from our server IP/domain?Also, we don’t see a REST API settings or IP Restrictions panel in the admin UI — is it possible to enable this?Thank you!

462
L
SysAider
A
a.subasheNew SysMate
asked in SysAid API
Access API Key

I’m trying to find the API key to create a RESTful API between SysAid’s Copilot and our company’s intranet.

1094
A
P
pgalloNew SysMate
asked in SysAid API
Need working example of creating service request via REST API

I’m able to use the login endpoint to retrieve a cookie, and then use that cookie string to request other GET endpoints to return information on users or service request templates…But when I go to create a new service request, I get a very unhelpful Error 500 no matter what I try.I’m currently trying to POST against: /api/v1/sr?view=mobile&type=incident&template=29I’m using ‘mobile’ as the view because it’s the only string I can get to return anything.  As far as I can tell, we only have a ‘DEFAULT’ view setup in Sysaid, but providing ‘default’ as the view URL parameter or not specifying the view URL parameter always returns the Error 500 message, while providing ‘mobile’ as the view URL at least returns "The following mandatory fields are missing: [problem_type, title, status, urgency, impact, priority, request_user, description]" if they are not provided.So, with a header containing my cookie and Content-Type: application/json, and my request body:{ "info": [ {"key"

2305
A
E
eder.fernandesNew SysMate
asked in SysAid API
API Login Call returns an HTML Login page instead of access token

Hello, I am trying to set up a connection with the API, but both in python and postman the response that I get is an HTML text asking me to sign in and code 200.In postman I used:"user_name":"XXXXXX","password" :"XXXXX","account_id":"XXXX" I also tried to use those parameters in the params tab instead of the Body, but I got the same result. In python, I get the same result in response of the following code:OWM_endpoint = "https://XXXXXXXXXXX.br/api/v1/login"user = "myuser"PASSWORD = "mypassword"account_id = "myaccount_id"parameters = { "user_name": user, "password": urllib.parse.quote_plus(PASSWORD), "account_id": account_id,}headers = { "Content-Type": "application/json"}response = requests.post(OWM_endpoint, params=parameters, headers=headers)print(response.text)print(response)The code returns the same html page asking me to sign in:<!-- Copyright (C) Microsoft Corporation. All rights reserved. --><!DOCTYPE html><html dir="ltr" class="" lang="en"><hea

742
E
R
Community Enthusiast
ronentCommunity Enthusiast
asked in SysAid API
SR Type Values

HiAre these the correct SR type values?"value": 1 = "valueCaption": "Change""value": 2 = "valueCaption": "Problem""value": 3 = "valueCaption": "Incident""value": 4 = "valueCaption": "Request"

302
R
Community Enthusiast
C
ChrisNew SysMate
asked in SysAid API
Create End Users via API

Is it possible to create  end users via API (or is that on the roadmap)?  We are automating our onboarding process, and being able to do this would eliminate one more step our techs need to do when staff are hired.  Thank you!

1025
dragos.baciu
SysAider
J
joepopNew SysMate
asked in SysAid API
SysAid API Ticket Creation Failing for CapCut Website Error Reports

Hi everyone,I'm working on integrating SysAid with my CapCut-related website to automatically create support tickets whenever users report issues. The goal is to send error reports from my website’s contact form directly to SysAid’s API as new service requests.Setup Details:Website: Built on WordPress (with a custom PHP script handling form submissions). SysAid API: Using /api/v1/requests endpoint to create tickets. Form Data Sent: User’s email, issue type (e.g., video export failure, login issue), error message, and timestamp. Authentication: Using an API key (works in Postman).Problem:When submitting the form, my API request returns a 401 Unauthorized error. The same API key works in Postman, but not when used in my PHP script. Tried both Authorization: Bearer <API_KEY> and sysaid-api-key: <API_KEY> headers—same issue. Debug logs show that the request never reaches SysAid, possibly being blocked by a security rule.Questions:Does SysAid block API requests from certain refe

543
L
SysAider
A
atrofmanNew SysMate
asked in SysAid API
What shall be used for resposnsibility to be none when creating a ticket?

We are creating tickets in sysaid and use responsibility null or ‘’. Either one of these brings process manager in sysaid to be a service account that is assigned for API.Any suggestion on how to make it none?

322
A
E
EDWIN HERNANDEZNew SysMate
asked in SysAid API
FALLA CON LA API/ATTACHMENT

Hola a todosEstoy luchando para agregar un archivo adjunto desde la api, comparto caprura.  

171
E
H
hjacqueminNew SysMate
asked in SysAid API
SR Attachment - Powershell - Internal Error 500

Hello Everybody, I’m struggling to add a attachement (xlsx file) to an existing SR. Here is my code :Function Add-SysAidRequestAttachment { [CmdletBinding()] Param ( [parameter(Mandatory=$true)] [String]$BaseURL, [Parameter(Mandatory=$true)] [Microsoft.PowerShell.Commands.WebRequestSession]$SessionToken, [parameter(Mandatory=$true)] [String]$RequestID, [parameter(Mandatory=$true)] [String]$FilePath ) Begin { $VerbosePreference = 'Continue' } Process { Write-Host "Entering Add-SysAidRequestAttachment" # Préparer l'URL pour l'upload du fichier [System.Uri]$Uri = "$BaseURL/api/v1/sr/$RequestID/attachment" # Lire le fichier à envoyer Try { $fileStream = [System.IO.File]::OpenRead($FilePath) $fileSize = $fileStream.Length Write-Host "Fichier chargé : $FilePath, Taille : $fileSize bytes" } Catch { Write-Host "Erreur lors de la

754
E
R
rui.novaisNew SysMate
asked in SysAid API
API login

Hi thereI have an on-prem SysAid instalation.And I need to automate some task, by Microsoft Power Automate.One of them is, make http request on Power Automate, to SysAid to check new sr.I already created a specific user for that op and given administrator permissions.I’m trying to make a post test login, with Avanced Rest Client (with access to SysAid) and the error I get is{  "status": 401,  "message": "Incorrect login information. Letters must be typed in the correct case. Please make sure the Caps Lock key is disabled."}Can you please tell me what could be the problem?Thanks.

573
S
SysAider
R
Community Enthusiast
ronentCommunity Enthusiast
asked in SysAid API
SysAid API Status Code list

Hi I can’t find in the documentation a list of the different available statutes and their appropriate code.I need it in order to update a Service Request’s status using the API.Is there such a list?

373
A
R
Community Enthusiast
rgireyevCommunity Enthusiast
asked in SysAid API
SysAid REST API setting sub_type causes error 500 to be returned

Solved. Please delete. 

291
C
SysAider
A
anitha.gNew SysMate
asked in SysAid API
Space category

hi guyz can assist me ...im having issue in space environment where by the category is not populating. any solutions?  

300
A
S
Sea_TonNew SysMate
asked in SysAid API
Authentication issues when logging into SSP and Ticketing system

We are on-prem. No one can authenticate with their AD account, but pressing f11 will take you to the ssp logged in. So this work around is helping users create tickets. This also helps me as an admin get logged into the helpdesk. Though this may work it is not ideal.When logging into the helpdesk with ad account and password I receive “Incorrect login information.Letters must be typed in the correct case.Please make sure the Caps Lock key is disabled.”My account is not locked in AD and I’ve tried logging in using Chrome, Firefox, and Edge.When I use the domain\username I get “Wrong captcha”. We never used domain before - but figured I’d give it a go anyway.We did change to ldaps. Though I can’t remember if this problem happened before or after we changed this.Any ideas or more information I can provide?

1615
S
A
andr3a.dipaolaNew SysMate
asked in SysAid API
use routing rules for SR via API

It is possible to avoid automatically assigning the service record to yourself via API. I would like to create SRs via API which are then managed by routing rules inside help desk.

923
A
A
Active talker
abonfimActive talker
asked in SysAid API
Label "Survey status" in SR is not change by API

Hi Everyone,I’m facing a dumb issue herer. I have a Survey working very well making update by sysaid API.When a survey is done, there is a label call “Survey Status” in the SR that tell me that the survey was anwserd.  But When the ticket is mark as “Resolved”, the survey is send but the “Survey status” in the SR wasn’t change to “The survey was sent”.I’m trying to do this by API and I have no success. Anybody here can help me?Here what I’m doing by API.'https://mycompany.sysaidit.com/api/v1/sr/81980'PUT curl --location --request PUT 'https://{{ambiente}}/sr/81980' \--header 'Content-Type: application/json' \--data '{    "id": "81980",    "info": [               {            "key": "survey_status",            "value": 1        }    ]}' 

973
A
Active talker
W
willgalvaoNew SysMate
asked in SysAid API
Creating Service Request via REST API

I'm studying the api and I realized that whenever I open a new service request it is automatically assigned to me. Is there a way to not attribute it to anyone?

7876
A
Y
Community Enthusiast
YerssonHernandez99Community Enthusiast
asked in SysAid API
SysAid API can't apply two conditions (or more?) in a GET

Hi to everyone.I would like to verify what is wrong with my API request, as I am simply calling a view and a date filter. If I execute the view only, it works correctly, and if I execute the date filter only, it returns records within that date range. However, if I apply both conditions, neither the view nor the date filter work.https://sysaidit.com/api/v1/sr?view=Porcicultura&insert_time=1701580800000,1704105600000Thank you very much for reading.Let me know if you need any further assistance!

1071
SysAid Copilot
SysAider

Badge winners

Show all badges
Terms & ConditionsCookie settings