{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a96072b2-5021-45fb-ae3f-2a4c4c1cc9f4","name":"ConnectedYou API","description":"This is ConnectedYou's IoT Orchestration Hub (IOH) APIs. The ConnectedYou API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON responses, and uses standard HTTP response codes, authentication, and verbs.\n\n# **API endpoint**\n\nHostname: api.connectedyou.io\n\nProtocol: https\n\nContent-Type: application/json\n\n# Sorting and Filtering\n\nThe APIs support sorting and filtering on most parameters listed in n the documentation below.\n\n# Pagination\n\nThe API's which return a list of records support pagination using a limit and offset approach. The total number of records is also returned on each request, so that client code can skip to the end or page backwards as may be needed. The default limit value 50, which sets the page size.\n\nFor example\n\n``` json\n{\n    \"profiles\": [\n        ...\n    ],\n    \"limit\": 10,\n    \"offset\": 0,\n    \"total\": 1\n}\n\n ```\n\n# Rate Limiting\n\nTo protect our platform and ensure consistent performance, ConnectedYou enforces rate limits on production APIs.\n\n**Response Example:**\n\n``` json\n{\n    \"detail\": \"Rate limit exceeded\",\n    \"wait_seconds\": 1\n}\n\n ```\n\n# HTTP Response Status Codes\n\nThe API's are REST/JSON and therefore make use of HTTP status code in responses.\n\n### Success Responses\n\n| Response Code | Description |\n| --- | --- |\n| 200 OK | Request completed succesfully |\n| 201 Created | Request completed succesfully and resulted in the creation of a new record. e.g. a user is added |\n| 202 Accepted | Request is accepted for further processing asynchronously |\n\n### Client Error Responses\n\n| Response Code | Description |\n| --- | --- |\n| 400 Bad Request | A client request is not correct. Likely incorrect formatting or URL. |\n| 401 Unauthorized | The client request did not pass authorization checks. This could be incorrect credentials, or incorrect account or URL. |\n| 403 Forbidden | The client request did not pass authentication checks. It could be an expired token, or excessive authentication, or an invalid client IP or server URL. |\n| 404 Not Found | The client request did not match a valid URL. The URL is incorrect. Note: This is also returned if the client credentials are not valid for a specific account number in the URL. |\n| 405 Method Not Allowed | When an incorrect HTTP Method is used to send a request to a particular URL. e.g. a GET method is used when a POST method is expected. |\n| 413 Payload Too Large | The request entity (body) is larger than limits defined by server. |\n| 415 Unsupported Media Type | The request uses the incorrect content type (e.g. application/xml is sent instead of application/json) |\n| 422 Unprocessable Entity | The request parameters can not be processed |\n| 429 Too Many Requests | The client is exceeding the Rate Limits for the API. |\n\n### Server Error Responses\n\n| Response Code | Description |\n| --- | --- |\n| 500 Internal Server Error | The server failed to succesfully complete the request. This is not expected. |\n| 503 Service Unavailable | Temporary unavailability of the service |\n| 504 Gateway Timeout | The server is taking too long to complete a request and it has timed out. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11771724","team":566676,"collectionId":"a96072b2-5021-45fb-ae3f-2a4c4c1cc9f4","publishedId":"2s93m4WMjh","public":true,"publicUrl":"https://docs.api.connectedyou.io","privateUrl":"https://go.postman.co/documentation/11771724-a96072b2-5021-45fb-ae3f-2a4c4c1cc9f4","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"F55e61"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/58a3cd78-376c-445c-8b8a-1f268d52be7c/Y29ubmVjdGVkeW91X2xvZ29fc21hbGwucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"F55e61"}},{"name":"light","logo":"https://content.pstmn.io/6c48ef69-5786-4ccf-a2b2-bb31ce2f720b/Y29ubmVjdGVkeW91X2xvZ29fc21hbGwucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"F55e61"}}]}},"version":"8.10.1","publishDate":"2023-05-26T11:40:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/6c48ef69-5786-4ccf-a2b2-bb31ce2f720b/Y29ubmVjdGVkeW91X2xvZ29fc21hbGwucG5n","logoDark":"https://content.pstmn.io/58a3cd78-376c-445c-8b8a-1f268d52be7c/Y29ubmVjdGVkeW91X2xvZ29fc21hbGwucG5n"}},"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/12aaca71aacc60c71527e9e840c10bbdfa484f89ca70d88a3d55d0de773685ce","favicon":"https://res.cloudinary.com/postman/image/upload/v1685621228/team/t7mb1tvmvrh4ovor5drj.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://docs.api.connectedyou.io/view/metadata/2s93m4WMjh"}