{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"61ebda95-24a8-4c3e-9819-ca8ca1a66a64","name":"ABLSoft API","description":"The ABLSoft API exposes selected pieces of information via a standardized programmatic interface. This is an enterprise API and it is assumed that prior to use of the ABLSoft API your company has access or permission to access an existing ABLSoft system. If you do not have access to an instance of ABLSoft please contact your ABLSoft representative for more information. If you have access to a ABLSoft system, but cannot consume the API contact your ABLSoft representative for information on enabling these services.\n\nThese examples serve as a starting point to familiarize yourself with some of the capabilities of the ABLSoft API. Custom API's and changes to the existing API's can be provided upon request. Contact your ABLSoft representative if you do not see your desired API available. If you have technical questions about the API please email your questions to [techsupport@ablsoft.com](https://mailto:techsupport@ablsoft.com).\n\nThe API is accessed by making HTTP requests to a specific endpoint URL, in which GET or POST variables contain information about what you wish to access. Every endpoint is accessed via an SSL-enabled HTTPS (port 443) using OAuth2, ABLSoft currently supports the OAuth2 Password Grant Type. Application developers must first obtain their CLIENT ID and SECRET CODE. This along with a valid username, password and appropriate security role to the specific ABLSoft instance is required in order to obtain a unique OAuth2 token. To receive your assigned credentials, please contact technical support or your companies system administrator.\n\nBecause all transactions are secured using the OAuth2 protocol, a valid token must first be obtained by passing the correct authentication credentials to the ABLSoft application server. Upon successfully validating the credentials, the ABLSoft system will return a unique OAuth2 token. This token can then be used repeatedly by the calling application to access ABLSoft resources. Applications should store the token for later use to avoid repeating the user id and password steps in the future. Tokens expire after 1 hours; use the refresh token, or a previously generated refresh token, to retrieve a new access token when the first token expires.\n\nFirst, use the GET refresh token service along with your ABLSoft credentials, retrieve the refresh token.\n\nRequest:  \n`$ curl --user MYCLIENTID:MYSECRETCODE` [<code>https://mycompany.ablsoft.com/restapi/oauth/token</code>](https://mycompany.ablsoft.com/restapi/oauth/token) `-d username=myID -d password=myPWD -d grant_type=password`\n\nResponse:  \n`{\"access_token\":\"bc156287-4662-4d5e-8c9d-51be256bda7d\",\"token_type\":\"bear er\",\"refresh_token\":\"368b1c65-d7a4-4eb3-9b23-c161df7262cb\",\"expires_in\":359 9,\"scope\":\"read write\"`\n\nNext, use the previously obtained refresh token to generate an access token.\n\nRequest:  \n`curl --user MYCLIENTID:MYSECRETCODE` [<code>https://mycompany.ablsoft.com/restapi/oauth/token</code>](https://mycompany.ablsoft.com/restapi/oauth/token) `-d grant_type=refresh_token -d refresh_token=368b1c65-d7a4-4eb3-9b23-c161df7262cb`\n\nThis access token will be used for authorization for all other API requests.\n\nAs mentioned earlier, each client application must have its own unique login id and password to interface with the ABLSoft API. The ID assigned is also tied to a security role that determines what resources the application will have access to. If you do not have access to a specific resource, contact your ABLSoft representative.\n\nTo interface with a ABLSoft web service, an HTTPS request must be formatted with the appropriate parameters as expected by the method in question. ABLSoft web services return JSON objects by default. Depending on the method called, the JSON returned could either be a list or a single object.\n\nABLSoft recommends testing API connectivity using the\n\n<a href=\"https://www.getpostman.com/docs/v6/\">Postman client</a>\n\n.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"23984599","team":100666,"collectionId":"61ebda95-24a8-4c3e-9819-ca8ca1a66a64","publishedId":"2sB3QQHT4H","public":true,"publicUrl":"https://apidocs.ablsoft.com","privateUrl":"https://go.postman.co/documentation/23984599-61ebda95-24a8-4c3e-9819-ca8ca1a66a64","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-10-17T12:58:11.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/d6c64899b26de25cb6011af8271e8567d925f39dea96df8fc6b076e8a4f726f8","favicon":"https://ablsoft.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://apidocs.ablsoft.com/view/metadata/2sB3QQHT4H"}