{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"613a7858-dd60-4ba0-97c8-651422d7bd51","name":"Public API  3","description":"# Things to Know\n\n- The API endpoints are POST requests ONLY and require that the request parameters be properly formatted JSON and that the JSON request go directly into the body of the request.\n    \n- Requests are for retrieving data only. If you need to post updates and add data, please contact us [support@invintus.com](https://mailto:support@invintus.com)\n    \n- Recurring requests are limited to 1 per second, per endpoint.\n    \n- Please be courteous to others by using best practices and limiting your requests to only what is needed for your application or website.\n    \n\n> Requirements to make API calls \n  \n\n- API Keys are required. To retrieve your API key, please view the \"Api Key\" tab in the accounts section of the Control Center application. If you do not have an API key, you can contact [support@invintus.com](https://mailto:support@invintus.com) to request one.\n    \n- Your Customer Identification number (clientID) is required to make API requests, this can be found at the top toolbar of the Control Center interface or in the \"Api Key\" tab in the accounts section of the Control Center\n    \n\n# Common Tasks\n\nThe most common API Tasks is in the retrieval of Event Listings or a Single Events status or URI’s for common 3rd party players. Here are a few notes on each method type in order to explain some of the details.\n\n## Listings\n\nretrieves multiple records based on query parameters\n\n\\*To Know: \\*\n\n- Listings returns blocks of events (resultPage) that can be designated by the total amount of records to retrieve (resultMax) per page. The default resultPage starts a 1 and the default \\*resultMax \\*is 20 records per-page.\n    \n- Combinations of search terms default to AND, meaning that the more search terms fields searched, the less results retrieved since it’s dictating \"THIS AND IS THAT\". Use the “AndOr” operator if you need “THIS OR IS THAT”. OR calls are significantly longer running.\n    \n- getDetailed and search methods are the now the same method, search method will be depreciated in future releases.\n    \n\n## Search\n\nThe search endpoint can take most if not all of the listing params, but also the data is retrieved from a fast in memery cache system that can do search engine type queries. Its a much faster and perfomant way of retrieving lists of events. Note some of the other params in the query example such as terms.\n\n## Stream URI’s\n\nEvent/getStreamLinks, Event/get\\* using \"showStreams\": true\n\n## Acceptable Use\n\n- Misuse of API by means of making requests greater than 1 per second will result in revoking API access.\n    \n- Replicating features of the INVINTUS Platform management interface is not authorized.\n    \n- Do not provide content to third parties, including downloadable datasets of Content or an API that returns Content, you will only distribute or allow download of Media assets or meta-data under client owners and Invintus Media LLC.’s explicit permission or under the client's contractual terms with Invintus Media LLC. Any Content provided to third parties via non-automated file download remains subject to this Policy.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"934987","team":287487,"collectionId":"613a7858-dd60-4ba0-97c8-651422d7bd51","publishedId":"2sAYXEEdQQ","public":true,"publicUrl":"https://docs.publicAPI.invintus.com","privateUrl":"https://go.postman.co/documentation/934987-613a7858-dd60-4ba0-97c8-651422d7bd51","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"114769"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/df63ae79-d5ac-4670-8c97-9b9cfe26e5e4/Z21haWxpY29uLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"70be44"}},{"name":"light","logo":"https://content.pstmn.io/df63ae79-d5ac-4670-8c97-9b9cfe26e5e4/Z21haWxpY29uLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"114769"}}]}},"version":"8.10.1","publishDate":"2025-02-16T22:48:04.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/df63ae79-d5ac-4670-8c97-9b9cfe26e5e4/Z21haWxpY29uLnBuZw==","logoDark":"https://content.pstmn.io/df63ae79-d5ac-4670-8c97-9b9cfe26e5e4/Z21haWxpY29uLnBuZw=="}},"statusCode":200},"environments":[{"name":"Documentation","id":"f36f172f-1056-4188-bb76-6f54569c8c2f","owner":"934987","values":[{"key":"CLIENTID","value":"1000000000","enabled":true,"type":"default"},{"key":"APIV3HOST","value":"https://api.v3.invintus.com","enabled":true,"type":"default"},{"key":"APIKEY","value":"BBUAXVMZLk5vYvGM","enabled":true,"type":"secret"}],"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/0a8002ef5f7a87dc306727464e1acd6e609d82f9a9cec0d962cb5ba03802e406","favicon":"https://invintus.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":"Documentation","value":"934987-f36f172f-1056-4188-bb76-6f54569c8c2f"}],"canonicalUrl":"https://docs.publicapi.invintus.com/view/metadata/2sAYXEEdQQ"}