{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"22d8c889-32b1-49e9-aec4-2b78ee31c249","name":"HSI Public API","description":"Contained here are a set of tools to allow you to manage your organization in HSI without going through the HSI Platform UI. These tools are designed to make it possible for you to integrate data from HSI into your own systems via HTTP web requests.\n\nIn the following subsections you will find general descriptions of authorization handling, and of general request/response object formatting practices that HSI adheres to.\n\nAll request/response objects use JSON, and dates are all in UTC.\n\nFollowing this section are descriptions of the actions you can perform through the HSI API, with examples.\n\nThank you for choosing HSI.\n\n---\n\n###### Authorization\n\nAuthorization is handled using an X-HSI-API-KEY. When you receive your organization's API key from HSI, you will need to add it to the header of any request sent to the HSI API.\n\n`X-HSI-API-KEY: {Your API Key}`\n\n---\n\n###### Standard Responses\n\nMost responses will follow this `GenericResult` pattern.\n\n- **data** contains an object with the result data from the request.\n    \n- **error** is an `ErrorReturn` object. It is null if the request succeeded.\n    \n- **message** is an additional message `string`. It is typically null.\n    \n- **success** is a `boolean` that is `true` if the request succeeded, and false otherwise.\n    \n\n``` json\n{\n    \"data\": {},\n    \"error\": null,\n    \"message\": null,\n    \"success\": true\n}\n\n ```\n\n`ErrorReturn` objects look like the following:\n\n- **type** is unused, and will be null.\n    \n- **message** is a `string` containing the error message.\n    \n- **httpcode** is the HTTP response code of the error.\n    \n- **exception** is a largely internal field, and will always be returned with the same value.\n    \n- **hsiErrorLogId** is the ID of an error in HSI's logging database. Not all failed requests generate an error log. This value defaults to 0.\n    \n\n``` json\n{\n    \"type\": null,\n    \"message\": \"string\",\n    \"httpcode\": 400,\n    \"exception\": \"There was an error processing the request\",\n    \"hsiErrorLogId\": 0\n}\n\n ```\n\n---\n\n###### List Requests\n\nAll list requests follow a standard `ListRequest` pattern.\n\n- **data** contains an object with the specific parameters for the request.\n    \n- **offset** sets the number of results to skip. Default is 0.\n    \n- **limit** sets the maximum number of results to return. Default is 50, maximum is 500.\n    \n\n``` json\n{\n    \"data\": {},\n    \"offset\": 0,\n    \"limit\": 50\n}\n\n ```\n\nResponses to list requests are also standardized as a `ListResponse`.\n\n- **data** is an array containing the specific result objects for the request.\n    \n- **error, message, and success** are the same as in `GenericResult`.\n    \n- **totalResults** is the count of all results that matched the search parameter. This number is not affected by _offset_ or _limit_.\n    \n- **moreResults** is a `boolean` that returns `true` if the returned results did not reach the end of the _totalResults_.\n    \n- **offset** returns the _offset_ value that used in the request.\n    \n- **limit** returns the _limit_ value that used in the request.\n    \n\n``` json\n{\n    \"data\": [],\n    \"error\": null,\n    \"message\": null,\n    \"success\": true,\n    \"totalResults\": 0,\n    \"moreResults\": false,\n    \"offset\": 0,\n    \"limit\": 50\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12295920","team":1203752,"collectionId":"22d8c889-32b1-49e9-aec4-2b78ee31c249","publishedId":"T1LJjTTm","public":true,"publicUrl":"https://documenter-api.postman.tech/view/12295920/T1LJjTTm","privateUrl":"https://go.postman.co/documentation/12295920-22d8c889-32b1-49e9-aec4-2b78ee31c249","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-08-07T22:25:03.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"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/4b0d8752814643f26b29f95e51975bdb52c7364542663dc3d7f710eae948632b","favicon":"https://res.cloudinary.com/postman/image/upload/v1596750453/team/hkg9nznuqlxg2zjzbkqz.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://documenter.gw.postman.com/view/metadata/T1LJjTTm"}