{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","description":"Welcome to LiveMentor's RESTful API.\n\nThe API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.\n\n# Authentication\n\nThis API uses `Authorization` header to authenticate requests.\n\nA JSON Web Token (JWT) must be specified in every request.\n\nJWT is a compact URL-safe means of representing claims to be transferred between two parties.\n\nFor more information about JWT checkout out this [resource](https://jwt.io/introduction/).\n\n## Token generation\n\nUse the `/login` endpoint to generate a new token.\n\n``` bash\ncurl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' --data '{\"user\": {\"email\":\"bruce.lee@mail.com\",\"password\":\"HelloWorld\"}}' https://api.livementor.com/login \n\n ```\n\n```\n{\n  \"data\":{\n    \"jwt\":\"xxxxx.yyyyy.zzzzz\"\n  }\n}\n\n ```\n\nSee [Auth section](#8048e759-b982-4c3c-a348-0940c1561186) for more information.\n\n## Token usage\n\nTo query the API you must provide a Json web token.\n\n``` bash\nJWT_TOKEN=xxxxx.yyyyy.zzzzz\ncurl -H 'Accept: application/json' -H \"Authorization: Bearer ${JWT_TOKEN}\" https://api.livementor.com/v1/users/me\n\n ```\n\n## Token revocation\n\nBy default, token have a 24h period validity.  \nYou can also manually invalidate a token with `/logout` endpoint.\n\n``` bash\ncurl -X DELETE -H 'Accept: application/json' -H \"Authorization: Bearer ${JWT_TOKEN}\" https://api.livementor.com/logout\n\n ```\n\nSee [Auth section](#8048e759-b982-4c3c-a348-0940c1561186) for more information.\n\n# Responses & errors\n\nAs much as possible, responses follow common HTTP conventions as much as possible.\n\n| code | name | explanation |\n| --- | --- | --- |\n| 200 | OK | Everything went okay |\n| 201 | Created | Returned when POSTing to create a new resource was successful |\n| 400 | Bad Request | The request was malformed |\n| 401 | Unauthorized | Invalid credentials supplied |\n| 422 | Unprocessable Entity | EA POST data JSON key or alike is malformed or missing |\n| 500 | Internal Server Error | If you encounter this, please get in touch - this should not happen |\n\n## Successful calls\n\nSuccessful requests that result in 200 response codes will have their data inside a key named _data_:\n\n``` json\n// 200 OK\n{\n  \"data\": \"Response data here\"\n}\n\n ```\n\n## Error messages\n\nWhenever an error occurs an error message will be available in a key named _error_:\n\n``` json\n// 404 Not found\n{\n  \"error\": {\n    \"message\": \"Error message here\",\n  }\n}\n\n ```\n\n# Pagination\n\nPagination information are sent as metada in the payload.  \nHere is a sample payload with pagination:\n\n``` json\n{\n  \"data\": [\n    { ... },\n    { ... },\n    { ... },\n    { ... }\n  ],\n  \"total_items\": 100,\n  \"pagination\": {\n    \"current_page\": \"/v1/training_courses?page=4\",\n    \"first_page\": \"/v1/training_courses?page=1\",\n    \"last_page\": \"/v1/training_courses?page=10\",\n    \"next_page\": \"/v1/training_courses?page=5\",\n    \"prev_page\": \"/v1/training_courses?page=3\"\n  }\n}\n\n ```\n\nThe following parameters can be used to interact with paginated endpoints:\n\n- `limit_offset`: the number of items to return per page. From 1 to 100, default is 50\n    \n- `page`: the page number to return\n    \n\n# Request IDs\n\nEach API request has an associated request identifier. You can find this value in the response headers, under `X-Request-Id`.\n\n# Versionning\n\nAPI version is specify in the past of the request.  \nExemple: `GET api.livementor.com/v1/users/me`","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"5804020","collectionId":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","publishedId":"TVejiqUj","public":true,"publicUrl":"https://developer.livementor.com","privateUrl":"https://go.postman.co/documentation/5804020-f3f31499-a7f0-4701-9dd3-fd84685e71f7","customColor":{"top-bar":"F7C947","right-sidebar":"283339","highlight":"4184DF"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2020-11-10T16:11:20.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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://livementor.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"}],"canonicalUrl":"https://developer.livementor.com/view/metadata/TVejiqUj"}