{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e13c776d-803f-7c57-e869-21dd160facd5","name":"Meural REST API","description":"The Meural REST API allows you to manage your Canvases and content. Here are some of the things you can do.\n- Register and configure Canvases\n- Manage artwork on your Canvas\n- Browse Meural's collection of artwork and artists\n- Upload your own images\n- Create playlists containing artwork from Meural's collection and your own\n\n# Nomenclature\nThere are a few discrepancies between user-facing language and the language we use in the API. The words `gallery` and `playlist` and synonyms, as are `item` and `artwork`, and `device` and `canvas`. We use these words interchangeably throughout our documentation.\n\n# Authentication\nWe use token based authentication. Any authenticated request requires an `Authorization` header with the value of `Token {{YOUR_TOKEN}}`. To obtain your token, all you need to do is create an account.\n\n# Standard Requests & Responses\nRequest data can be encoded as `JSON`, `url`, or `form`. JSON is prefered. There are some endpoints that require JSON and others that require form-encoded data.\n\nAll standard responses are in JSON format and have the following form.\n\n| Key | Value Type | Description |\n| --- | ---------- | ----------- |\n| data | Object or Array | The requested resource |\n| message | String | A message for the user about the status of the request |\n| isPaginated | Boolean | Indication of whether or not the response is paginated |\n| isLast | Null or Boolean | Indication of whether or not the response is the last in a paginated list if the response is paginated |\n| count | Null or Int | The total number of objects in the paginated list |\n\n# Error Responses\nError responses are responses whose status code is >= 400. All error responses are JSON objects with either a general error under the key `errors` or field specific errors under keys matching the field name. The errors themselves are always strings.\n\n# Pagination\nAll list responses are paginated and the page number can be specified with the `page` querystring parameter. The default page size is 10; and there is an optional `count` parameter that allows you to specify the page size.\n\n# Filtering and Sorting\nFiltered and sorted responses are requested with querystring parameters. Endpoints that support filtering and sorting can be requested with either filter or sort parameters, where each points to a valid argument. Arguments are formatted as `{filter or sort type}__{filter or sort value}`. For example,\n```\n/artists/?filter=name__a\n```\nwill retrieve those artists whose names start with a.\n\n### Available Sorts and Filters by Model\n\n| Model | Sort | Filter |\n| ----- | ---- | ------ |\n| Channel | `date_added` | `name` |\n| Artist | `date_added`, `name`, `time_period` | `name`, `time_period` |\n| Model/Items | `date_added`, `name`, `time_period` | None |\n| Model/Galleries | `date_added`, `name` | None |\n| Model/Artists | `date_added`, `name` | None |\n\n### Accepted Sort and Filter Values\n\n| Type | Subtype | Values |\n| ---- | ------- | ------ |\n| Sort | `name` | `asc`, `dsc` |\n| Sort | `date_added` | `asc`, `dsc` |\n| Sort | `time_period` | `asc`, `dsc` |\n| Filter | `name` | `a` to `z` |\n| Filter | `time_period` | `Renaissance`, `1600`, `1700`, `1800`, `1900`, `2000` |\n\n# Content Hierarchy\n\nMeural's content hierarchy allows us to group artists, galleries, and artworks together by various qualities such as time period, style, or color, for example. We can take a `group` at the top of the hierarchy and drill down into its sets of artwords and artists; and we can also take an `item` at the bottom of the hierarchy and find its relationships to other `items`, `artists`, `categories`, etc.\n\nThe lowest level of our content hierarchy is the `item`, which is the artwork itself with various metadata. One level above `item` is `gallery`. `galleries` are collections of items and they are the only objects that can be sent to Canvases. Above `gallery` is `artist`. `artists` have both `galleries` and `items`; and above `artists` are `categories`, which have `artists`, `items`, and `galleries`. One futher layer in the hierarchy is `groups`, which are groups of `categories`.\n\n`channels` stand outside of this hierarchy and are used to group `items`, `artists`, and `galleries` together by more arbirary concepts, such as the partner that provided the artwork, or a theme devised by a curator.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1657302","team":59137,"collectionId":"e13c776d-803f-7c57-e869-21dd160facd5","publishedId":"RVnWjKUL","public":true,"publicUrl":"https://documenter-api.postman.tech/view/1657302/RVnWjKUL","privateUrl":"https://go.postman.co/documentation/1657302-e13c776d-803f-7c57-e869-21dd160facd5","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2018-05-29T18:28:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"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/df598da0484874d4cb26eabfefab14786fa22f84e17a3af8907dee0e58d74465","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/RVnWjKUL"}