{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"cbc9a4ae-11a5-479e-94fa-94ce85c9a85c","name":"Insites","description":"<img src=\"https://content.pstmn.io/1c7af05a-e7e5-48ff-b808-2d69107a0163/cG9zdG1hbi1oZXJvLnBuZw==\">\n\n# Overview\n\n- This is a collection of the Insites public API's which return JSON-encoded responses.\n    \n- For documentation about the Insites platform, please go to [https://docs.insites.io](https://docs.insites.io/)\n    \n- This Collection includes API documentation for all areas of the Insites Platform:\n    \n    - [Instances](https://apidocs.insites.io/#4d9f072f-39d0-4b07-a5d6-94153f850e2a)\n        \n    - [Marketplace](https://apidocs.insites.io/#ec4ce778-7e4b-4337-b7b7-53eab59f4f8d)\n        \n    - [Console](https://apidocs.insites.io/#2684a424-688f-4352-be45-f30e902e3b57)\n        \n- To quickly get started with the APIs, click the **Run in Postman** button located at the upper right corner of your screen. Choose whether to run on the Postman website or in the application and import this collection to your own workspace.\n    \n- You can set up and select the respective Environment when making calls for this Collection.\n    \n\n# Authentication\n\n- To authorize API access, please ensure you use your **`Instance API Key`** , which can be found within the Instance Admin.\n    \n    - Navigate to **Integrations** from the main menu\n        \n    - Go to the **Instance API Key** page\n        \n        - _Authorization type:_ **API Key**\n            \n        - _Key:_ **Authorization**\n            \n        - _Value:_ {{ **`Instance API Key`** }}\n            \n\n### Environment\n\nThis collection needs an environment, and you must set up its variables to run a request. These are the variables required:\n\n| Name | Description |  |\n| --- | --- | --- |\n| `Instance URL` | Your Insites Instance's URL | Mandatory |\n| `Instance API Key` | Your Instance's API Key (_Located under the Integrations Tab -> Instance API Key page_) | Mandatory |\n\n# Error Codes\n\n- Responses are all in JSON format and will have appropriate HTTP status codes. You will get a `200` status response if the request succeeds. While `400` indicates an error, when this happens, an `\"error\": {}` key containing the error message will be in the response. These are the common status used in our endpoints:\n    \n    - `400` = error\n        \n    - `207` = partial error (_ie. handling multiple graphql endpoints_)\n        \n    - `200` = success\n        \n- In some cases, you might receive a `401` status. This indicates an _Unauthorized_ error when you try to send a request on an endpoint that needs an authorization key.\n    \n    - You will receive this message in the response:\n        - \\*\"Authorisation Required / Unauthorized Access\"\\*\n            \n\n# Rate Limit\n\n- Access to the API in Postman is limited to **300 requests per minute**. You will receive this JSON response once you hit the limit. This comes with a `429 Too Many Requests` status code\n    \n\n``` json\n{\n  \"error\": {\n    \"name\": \"rateLimitError\",\n    \"message\": \"Rate Limit exceeded. Please retry at 1465452702843\"\n  }\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"18494178","team":2809343,"collectionId":"cbc9a4ae-11a5-479e-94fa-94ce85c9a85c","publishedId":"Uyxbq9xV","public":true,"publicUrl":"https://apidocs.insites.io","privateUrl":"https://go.postman.co/documentation/18494178-cbc9a4ae-11a5-479e-94fa-94ce85c9a85c","customColor":{"top-bar":"000000","right-sidebar":"303030","highlight":"3044FF"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-07-29T08:27:59.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Insites","id":"43479add-2627-42b3-81e0-ac9ce7c98518","owner":"18494178","values":[{"key":"Instance URL","value":"{{Instance URL}}","enabled":true,"type":"default"},{"key":"Session Key","value":"{{Session Key}}","enabled":true,"type":"default"},{"key":"CSRF Token","value":"{{CSRF Token}}","enabled":true,"type":"default"},{"key":"X CSRF Token","value":"{{X CSRF Token}}","enabled":true,"type":"default"},{"key":"CRM Activities Auth","value":"{{CRM Activities Auth}}","enabled":true,"type":"default"},{"key":"https://hs0irqy0ha.execute-api.ap-southeast-2.amazonaws.com","value":"","enabled":true,"type":"default"}],"published":true}],"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/a50bc175f029359f366f099f39a60e59b7570dc8fe6fdec850898bf24b6ffa6c","favicon":"https://res.cloudinary.com/postman/image/upload/v1659496702/team/uy3w3t75gg1c6bmdcubb.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"},{"label":"Insites","value":"18494178-43479add-2627-42b3-81e0-ac9ce7c98518"}],"canonicalUrl":"https://apidocs.insites.io/view/metadata/Uyxbq9xV"}