{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"517d81f2-ce92-b598-752a-30b52d6296ac","name":"Beebeeboard RESTful API","description":"<h1 id=\"getting-started\">Getting started</h1>\n<p>Our RESTful API lets you interact with Beebeeboard using JSON over HTTPS.</p>\n<p>The following resources will help you get up to speed.</p>\n\n<h2 id=\"beebeeboard-api-endpoints\">Beebeeboard API Endpoints</h2>\n<p>The API is accessed via <code>https://{{organization}}.beebeeboard.com/api/v1</code> and speaks JSON over HTTPS.</p>\n\n<h2 id=\"general-pointers\">General Pointers</h2>\n<ul>\n<li><strong>HTTPS only</strong>: All requests are done over HTTPS.</li>\n<li><strong>UTF-8 encoding</strong>: All strings are sent and received in UTF-8.</li>\n<li><strong>JSON in, JSON out</strong>: Data is sent and received as JSON (although some endpoints return CSV or PDF documents).</li>\n<li><strong>Schemas</strong>: We're using the <a href=\"http://jsonapi.org/\" title=\"JSON API\">JSON API</a> format.</li>\n<li><strong>ISO Date format</strong>: Dates and DateTimes are in ISO 8601 format:<ul>\n<li>Date: <code>2013-07-18</code></li>\n<li>DateTime: <code>2018-07-18T19:30:06.445Z</code> OR <code>2018-07-18T19:30:06Z</code> (with or without milliseconds).</li>\n</ul>\n</li>\n</ul>\n\n<h2 id=\"http-methods\">HTTP Methods</h2>\n<p>We're trying to keep our URLs as RESTful as possible.\nThis means that every resource endpoint may support one or more of the following HTTP methods:</p>\n<ul>\n<li><code>GET</code> Retrieves information about a resource.</li>\n<li><code>POST</code> Creates a resource.</li>\n<li><code>PATCH</code> Partially updates a resource; only include the properties to be updated.</li>\n<li><code>DELETE</code> Deletes a resource.</li>\n</ul>\n\n<h2 id=\"errors\">Errors</h2>\n<p>The API uses standard HTTP status codes to indicate that a request has gone wrong.</p>\n<p>Additionally, the body of the response always contains a error (JSON) describing the issue in more detail.</p>\n<h3 id=\"-400-bad-request\"><code>400</code> Bad Request</h3>\n<p>HTTP Status <code>400</code> is returned when:</p>\n<ul>\n<li>You send invalid JSON, that does not conform to the schema for the endpoint.</li>\n<li>Business rules prevent the operation you are attempting.</li>\n</ul>\n\n<h3 id=\"-403-forbidden\"><code>403</code> Forbidden</h3>\n<p>HTTP Status <code>403</code> is returned when:</p>\n<ul>\n<li>You did not provide an access token in the query string: <code>?access_token=ACCESS_TOKEN</code> \nor as an <code>Authorization Bearer</code> HTTP header</li>\n<li>The token you are supplying has been revoked or is invalid. In this case stop calling the API with that token</li>\n</ul>\n\n<h3 id=\"-404-not-found\"><code>404</code> Not Found</h3>\n<p>The resource could not be found.</p>\n\n<h3 id=\"-500-internal-server-error\"><code>500</code> Internal Server Error</h3>\n<p>All endpoints can also return HTTP Status <code>500</code> (Internal server error)\nif there is a problem on the server. Most likely retrying the same\nrequest will return a <code>500</code> again.\n\n<h3 id=\"-503-service-unavailable\"><code>503</code> Service Unavailable</h3>\n<p>All endpoints can also return HTTP Status <code>503</code> (Service unavailble)\nif there is a temporary problem on the server. Often you can retry\nthe same request and have it succeed.</p>\n\n<h2 id=\"testing-the-api\">Testing the API</h2>\n<p>If you want to test your API calls we recommend using curl.\nAdditionally the API is CORS-enabled, so you can also use your browser as a sandbox for experimenting.</p>\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"5473091","team":160689,"collectionId":"517d81f2-ce92-b598-752a-30b52d6296ac","publishedId":"RWgm3ggv","public":true,"publicUrl":"https://documenter-api.postman.tech/view/5473091/RWgm3ggv","privateUrl":"https://go.postman.co/documentation/5473091-517d81f2-ce92-b598-752a-30b52d6296ac","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/44ce3d0a-1f1b-4c63-b45d-350ca418fae7/YXBwbGUtdG91Y2gtaWNvbi5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/44ce3d0a-1f1b-4c63-b45d-350ca418fae7/YXBwbGUtdG91Y2gtaWNvbi5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"}}]}},"version":"8.10.1","publishDate":"2023-06-05T14:59:01.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/44ce3d0a-1f1b-4c63-b45d-350ca418fae7/YXBwbGUtdG91Y2gtaWNvbi5wbmc=","logoDark":"https://content.pstmn.io/44ce3d0a-1f1b-4c63-b45d-350ca418fae7/YXBwbGUtdG91Y2gtaWNvbi5wbmc="}},"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/6e14312710ff546a0d03e017decbefdc0f73b8298c9e7a59ed39d07ea7fa7d7c","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/RWgm3ggv"}