{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"037a8f18-b3b7-4d88-b28a-450a7f5b0e77","name":"Appmiral Content API","description":"Welcome to the documentation of the Appmiral Content API.\n\n# Version History\n\n| **API Version** | State | Release Date | Deprecated | Deactivated |\n| --- | --- | --- | --- | --- |\n| ~~v4~~ | Deactivated | Jan 6 2017 | Feb 17 2020 | Jan 31 2022 |\n| ~~v5~~ | Deactivated | May 2 2019 | Feb 17 2020 | Jan 31 2022 |\n| v6 | Deprecated | Feb 17 2020 | Sep 14 2023 | \\- |\n| **v7** | **Active** | **Sep 14 2023** | \\- | \\- |\n\n# Common Fields\n\nThis section explains some of the common fields returned by the Appmiral Content API.\n\n#### Object IDs\n\nAlmost all objects returned by the Appmiral API have an `id` field. This is their unique ID in the Appmiral database. This value is always an integer and is unique **per object type**. Meaning a Stage and an Artist can both have `1` as their ID.\n\n#### External IDs\n\nSome content may be imported into Appmiral from third party systems, for example via our timetable importers. In that those objects will have an `external_id` field. This field is a string and will contain the ID of the object in the third party system.\n\n#### Priority\n\nSome types of content have a `priority` field. The value of this field is used to order the content in the user interface. **A lower value means more important**! Meaning priority 10 should be displayed before priority 50.\n\nNewly created objects in the Appmiral CMS will have a priority of 100 by default.\n\n#### Colors\n\nWhenever colors are returned by the Appmiral API, it will be a string in the form of a 6-digit HEX color code including the hashtag. For example **#F1C91A**.\n\n#### Dates\n\nAll dates are returned as ISO8601 timestamps. All dates are returned in UTC timezone. For example **2020-08-23T19:30:00+00:00**.\n\n# Images\n\nMany API endpoints will return objects that include images, e.g. Artists, Playlists, Sponsors, ... To ensure optimal performance on the clients, the Appmiral backend will automatically create various resized versions of all uploaded images.\n\nMobile devices exist in a wide variety of screen resolutions and pixel densities so there is no ideal thumb, small or large size that fits for each device. That is why the Image object contains keys indicating the **width** of the resized image. It is the **client's responsibility** to select the optimal image based on where the image is used.\n\nExample:\n\n``` json\n{\n    \"100\": \"https:\\/\\/s3-eu-west-1.amazonaws.com\\/appmiral-images\\/prod\\/performance\\/0023\\/12\\/thumb_2211326_performance_100.jpeg\",\n    \"250\": \"https:\\/\\/s3-eu-west-1.amazonaws.com\\/appmiral-images\\/prod\\/performance\\/0023\\/12\\/thumb_2211326_performance_250.jpeg\",\n    \"500\": \"https:\\/\\/s3-eu-west-1.amazonaws.com\\/appmiral-images\\/prod\\/performance\\/0023\\/12\\/thumb_2211326_performance_500.jpeg\",\n    \"960\": \"https:\\/\\/s3-eu-west-1.amazonaws.com\\/appmiral-images\\/prod\\/performance\\/0023\\/12\\/thumb_2211326_performance_960.jpeg\",\n    \"1080\": \"https:\\/\\/s3-eu-west-1.amazonaws.com\\/appmiral-images\\/prod\\/performance\\/0023\\/12\\/thumb_2211326_performance_1080.jpeg\"\n}\n\n ```\n\n# Requests","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"21064095","team":6032530,"collectionId":"037a8f18-b3b7-4d88-b28a-450a7f5b0e77","publishedId":"2sA3kaCyji","public":true,"publicUrl":"https://documenter-api.postman.tech/view/21064095/2sA3kaCyji","privateUrl":"https://go.postman.co/documentation/21064095-037a8f18-b3b7-4d88-b28a-450a7f5b0e77","customColor":{"top-bar":"eeeeee","right-sidebar":"303030","highlight":"ef5b25"},"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":"ef5b25"}},{"name":"light","logo":null,"colors":{"top-bar":"eeeeee","right-sidebar":"303030","highlight":"ef5b25"}}]}},"version":"8.11.6","publishDate":"2024-08-16T12:04:48.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/f042a2270438a87b3d5f64f71da550fa9a20d2e6b74d2f9a524b458a57afdb26","favicon":""},"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/2sA3kaCyji"}