{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ae1ca4ce-84db-43db-a9db-fdf9ed7d495e","name":"3rdRisk Api","description":"## Get started\n\nWelcome to the API documentation for 3rdRisk! This comprehensive guide is designed to help you understand and integrate our API seamlessly into your applications and services. Whether you're a seasoned developer or just starting your coding journey, this documentation will provide you with all the information you need to get up and running quickly.\n\n3rdRisk offers a wide range of functionalities that allow you to interact with our platform programmatically. With our API, you can effortlessly retrieve, create, update, and delete resources, enabling you to build robust and innovative solutions tailored to your specific needs. Our API supports standard HTTP methods, including GET, POST, PUT, and DELETE, and communicates using the **JSON:API** standard.\n\nIn this documentation, you'll find detailed explanations of each endpoint, along with example requests and responses. We have also included code snippets in multiple programming languages to assist you in implementing API calls effectively. Whether you prefer Python, JavaScript, Ruby, or any other popular language.\n\nTo get started, make sure you have an API key which is described below in the \"Authentication\" section. Once you have your key, you can begin exploring the various endpoints and their parameters. We recommend using an API development tool like cURL, Postman, or your preferred HTTP client to make requests and observe responses.\n\n# Authentication\n\nTo get started, make sure you have an API key, which is required for authentication. In the 3rdRisk platform, you can generate API tokens in the Configuration -> API tokens section. You need to specify the permissions that will be givven to the API token.\n\n<img src=\"https://content.pstmn.io/2b6e56f2-27c6-435b-9bc6-803f47801052/Q2xlYW5TaG90IDIwMjMtMDYtMDcgYXQgMTIuNDQuMzlAMngucG5n\" width=\"389\" height=\"401\">\n\nThe authentocation type is Bearer token. This means that every request should contain an \"Authentication\" header with the value of \"Bearer \\[your token\\]\".\n\n# JSON:API\n\nOur API adheres to the JSON:API standard ([https://jsonapi.org/](https://jsonapi.org/)).\n\nJSON:API required the use of the JSON:API media type `application/vnd.api+json` for exchanging data so you will need to specify this type in your `Accept` and `Content-Type` headers.\n\n# Pagination\n\nLaravel JSON:API paginators allow you to return a subset (\"page\") of results using the [JSON:API <code>page</code> query parameter.](https://jsonapi.org/format/#fetching-pagination)\n\nThis means the following request will received a paged response of the second page while there are 15 items on each page.\n\n``` http\nGET /api/v1/users?page[number]=2&page[size]=15 HTTP/1.1\nAccept: application/vnd.api+json\n\n ```\n\n# Base url\n\nThe base url for our V1 API is your domainname with `/api/v1/` [so for example: <code>https://my.company.3rdrisk.com/api/v1/</code>](https://my.company.3rdrisk.com/api/v1/Example)\n\n# Example requests\n\nWe've included example requests that will represent usecases. You can select them in the `Example requests` dropdown box.\n\n<img src=\"https://content.pstmn.io/4798b6bf-543e-4ecb-8e77-5abb601d3632/Q2xlYW5TaG90IDIwMjMtMDYtMDggYXQgMTAuMTguMTBAMngucG5n\" width=\"2816\" height=\"1492\">\n\n# Including relationships\n\nTo include relationships in a request you can pass a query string parameter as such `include=owner,manager`","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"24677675","collectionId":"ae1ca4ce-84db-43db-a9db-fdf9ed7d495e","publishedId":"2s93sZ7EHL","public":true,"publicUrl":"https://api.3rdrisk.com","privateUrl":"https://go.postman.co/documentation/24677675-ae1ca4ce-84db-43db-a9db-fdf9ed7d495e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"009a77"},"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":"009a77"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"009a77"}}]}},"version":"8.10.1","publishDate":"2023-06-09T08:54:04.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/bd3114a2345f7676bb7cff28d55775e5425278514028cc54ce7609c15592b7dc","favicon":"https://3rdrisk.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://api.3rdrisk.com/view/metadata/2s93sZ7EHL"}