{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8af8ff92-7e1e-4ebe-b39a-9789e98063db","name":"IntelligenceBank Public API","description":"The **IntelligenceBank Graph API (v3)** is the latest version of the **IntelligenceBank Public API**.\n\nThe calls listed below all work in conjunction with the **IntelligenceBank API (v2) login calls**, which are listed on this page under [Authentication](https://apidoc.intelligencebank.com/?version=latest#2aeafa0c-8d75-49be-8a61-4677da2cab80) for easy reference. To get started, you will need to retrieve the [API v2 URL (apiV2url)](https://apidoc.intelligencebank.com/?version=latest#fdd1d62c-27dc-4c72-94c9-396ac8006bc8).\n\nOn the **Login** call response ([Standard](https://apidoc.intelligencebank.com/?version=latest#d9ead492-1df9-4ea9-babf-06690a168dce) or [Browser](https://apidoc.intelligencebank.com/?version=latest#a01345b8-e9c4-4f39-9c83-a0f4e2519b02) methods), the following parameters are to be used in subsequent v3 calls:\n\n- **\"apiV3url\"**: this is the v3 API server URL, and the root URL of all API calls.\n \n- **\"sid\"**: this is the session id. It is to be added to the Headers. It will be valid for the length of the user session.\n \n- **\"clientid\"**: this is the client id and unique to your platform. It is to be added to the request URL for GET requests, or to the body part for POST requests.\n \n\n# Limits\n\n- A daily, monthly or yearly limit of calls for this API applies for each client account.\n \n- A rate limit of 600 calls per minute applies for each user account.\n \n\n# How to use this Collection with Postman?\n\n- **Import** the Collection into Postman by clicking **Run in Postman** on the top right of this page.\n \n- The Collection is configured to **populate as many parameters as possible automatically** so that you can get started easily with using these API calls.\n \n- Click the \"Eye\" icon on the top right, and modify the following values of the **API Default** environment, under the CURRENT VALUE column:\n \n - **{{platformurl}}**: Enter your IntelligenceBank platform URL (without https://)\n \n - **{{emailaddress}}**: Enter your IntelligenceBank username/email address\n \n - **{{password}}**: Enter your IntelligenceBank password\n \n- **Leave all other parameters unchanged** as these will populate automatically by triggering the following 2 API calls:\n \n - [Get V2 API URL (apiV2url)](https://apidoc.intelligencebank.com/?version=latest#fdd1d62c-27dc-4c72-94c9-396ac8006bc8): click Send to auto-populate the parameter value. This is required for the next call to work.\n \n - **Standard Login (v2)**: click Send to auto-populate the other parameters.\n \n- All parameters displayed in orange and needed in the calls should now be mapped to values.\n \n- Only parameters displayed in red (e.g. {{file_id}}) will require manual input.\n \n- NOTE: if you are login in to your platform via Single Sign On and/or 2 Factor Authentication, use the [Browser Login](https://apidoc.intelligencebank.com/?version=latest#a01345b8-e9c4-4f39-9c83-a0f4e2519b02) method to authenticate instead.\n \n\n\n\n# Common Error Responses\n\n| | | | |\n| --- | --- | --- | --- |\n| **ERROR CODE** | **DEFINITION** | **EXAMPLE ERROR MESSAGE(S)** | **EXAMPLE VERBOSE MESSAGES** |\n| **401 UNAUTHORIZED** | Your authentication session has expired. | error.authentication.required | “No valid session. Authentication is required” |\n| **403 FORBIDDEN** | When the user does not have permission to do the action on and/or access to the requested item. | \"error.no_permission\" | “No Permission” |\n| **404 NOT FOUND** | When the provided _id or id value does not exist or is for an archived item. | \"error.not_found\"

\"error.folder.parent.not_found\"

\"error.resource.not_found\"

“error.record.not_found”

“error.{{object}}.not_found” | “Not Found”

“Parent folder not found”

“Resource not found”

“Record not found”

“{{Object}} not found” |\n| **400 BAD REQUEST** | When the request parameters or body has invalid data.

Validation errors will be returned against that error code in version 3.0.0., and against error code 422 in version 3.0.1.+. | \"error.service.query_params.invalid\"

“{{field}}\": { \"error.validator.empty\": null }

“{{select_field}}\": { \"Value must be a match\": null }

\"{{date_field}}\": { \"error.validator.is_date\": { \"value\": \"{{wrong_value}}\" } | \"Bad request - query parameters are invalid\"

\"{{field}}\": { \"This field cannot be empty\": null }

“{{select_field}}\": { \"Value must be a match\": null }

\"{{date_field}}\": { \"Value must be a valid date\": { \"{{wrong_value}}\": \"\" } |\n| **422 UNPROCESSABLE ENTITY** | When the request parameters or body has validation errors.

Validation errors will be returned against that error code in version 3.0.1.+, and against error code 400 in version 3.0.0. | “{{field}}\": { \"error.validator.empty\": null }

“{{select_field}}\": { \"Value must be a match\": null }

\"{{date_field}}\": { \"error.validator.is_date\": { \"value\": \"{{wrong_value}}\" } | \"{{field}}\": { \"This field cannot be empty\": null }

“{{select_field}}\": { \"Value must be a match\": null }

\"{{date_field}}\": { \"Value must be a valid date\": { \"{{wrong_value}}\": \"\" } |\n| **429 TOO MANY REQUESTS** | When the API rate limit of 600 calls per minute has been reached. | \"error.api.rate_limit_reached\" | \"Rate Limit Exceeded. You have reached the maximum number of requests (600) allowed per minute.\" |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"720164","team":373797,"collectionId":"8af8ff92-7e1e-4ebe-b39a-9789e98063db","publishedId":"VUxLw8x1","public":true,"publicUrl":"https://apidoc.intelligencebank.com","privateUrl":"https://go.postman.co/documentation/720164-8af8ff92-7e1e-4ebe-b39a-9789e98063db","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"F68D32"},"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":"F68D32"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"F68D32"}}]}},"version":"8.10.0","publishDate":"2026-02-12T10:05:18.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"API Default","id":"d5f4faa2-6cd3-4836-bf23-5c014aaf8574","owner":"720164","values":[{"key":"platformurl","value":"{{platformURL}}","enabled":true},{"key":"emailaddress","value":"{{username}}","enabled":true},{"key":"password","value":"{{password}}","enabled":true,"type":"default"},{"key":"apiV2url","value":"{{apiV2url}}","enabled":true},{"key":"clientid","value":"{{clientid}}","enabled":true},{"key":"sid","value":"{{sid}}","enabled":true},{"key":"apiV3url","value":"{{apiV3url}}","enabled":true},{"key":"content","value":"{{content}}","enabled":true},{"key":"token","value":"{{token}}","enabled":true,"type":"any"},{"key":"productkey","value":"{{productkey}}","enabled":true,"type":"default"},{"key":"p60","value":"{{productkey}}","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/124e9005b3db17bb1b976faeaa967fc409f5c9b9e907e0f8676a935677af8c03","favicon":"https://intelligencebank.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"},{"label":"API Default","value":"720164-d5f4faa2-6cd3-4836-bf23-5c014aaf8574"}],"canonicalUrl":"https://apidoc.intelligencebank.com/view/metadata/VUxLw8x1"}