{"info":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","description":"

Welcome to LiveMentor's RESTful API.

The API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Authentication

This API uses Authorization header to authenticate requests.

A JSON Web Token (JWT) must be specified in every request.

JWT is a compact URL-safe means of representing claims to be transferred between two parties.

For more information about JWT checkout out this resource.

Token generation

Use the /login endpoint to generate a new token.

curl -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  \"data\":{\n    \"jwt\":\"xxxxx.yyyyy.zzzzz\"\n  }\n}\n\n

See Auth section for more information.

Token usage

To query the API you must provide a Json web token.

JWT_TOKEN=xxxxx.yyyyy.zzzzz\ncurl -H 'Accept: application/json' -H \"Authorization: Bearer ${JWT_TOKEN}\" https://api.livementor.com/v1/users/me\n\n

Token revocation

By default, token have a 24h period validity.
You can also manually invalidate a token with /logout endpoint.

curl -X DELETE -H 'Accept: application/json' -H \"Authorization: Bearer ${JWT_TOKEN}\" https://api.livementor.com/logout\n\n

See Auth section for more information.

Responses & errors

As much as possible, responses follow common HTTP conventions as much as possible.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

code	name	explanation
200	OK	Everything went okay
201	Created	Returned when POSTing to create a new resource was successful
400	Bad Request	The request was malformed
401	Unauthorized	Invalid credentials supplied
422	Unprocessable Entity	EA POST data JSON key or alike is malformed or missing
500	Internal Server Error	If you encounter this, please get in touch - this should not happen

Successful calls

Successful requests that result in 200 response codes will have their data inside a key named data:

// 200 OK\n{\n  \"data\": \"Response data here\"\n}\n\n

Error messages

Whenever an error occurs an error message will be available in a key named error:

// 404 Not found\n{\n  \"error\": {\n    \"message\": \"Error message here\",\n  }\n}\n\n

Pagination

Pagination information are sent as metada in the payload.
Here is a sample payload with pagination:

{\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

The following parameters can be used to interact with paginated endpoints:

limit_offset: the number of items to return per page. From 1 to 100, default is 50
\n
page: the page number to return
\n

Request IDs

Each API request has an associated request identifier. You can find this value in the response headers, under X-Request-Id.

Versionning

API version is specify in the past of the request.
Exemple: GET api.livementor.com/v1/users/me

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Responses & errors","slug":"responses-errors"},{"content":"Pagination","slug":"pagination"},{"content":"Request IDs","slug":"request-ids"},{"content":"Versionning","slug":"versionning"}],"owner":"5804020","collectionId":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","publishedId":"TVejiqUj","public":true,"customColor":{"top-bar":"F7C947","right-sidebar":"283339","highlight":"4184DF"},"publishDate":"2020-11-10T16:11:20.000Z"},"item":[{"name":"Auth","item":[{"name":"Login","event":[{"listen":"test","script":{"id":"2026bc05-9e6d-4211-87b9-c565f2249946","exec":["// Stores the JWT token in an environment or global variable","var jwtToken = pm.response.json().data.jwt;","pm.environment.set(\"LIVEMENTOR_AUTH_TOKEN\", jwtToken);"],"type":"text/javascript","packages":{}}}],"id":"87a65456-357a-4ae9-a9de-4be3024f9833","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"email\": \"mentor@livementor.com\",\n \"password\": \"WelcomeLiveMentor\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.livementor.com/login","description":"

Authenticates the user with the given credentials and returns a JWT token to be used for authenticated requests.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"8048e759-b982-4c3c-a348-0940c1561186","id":"8048e759-b982-4c3c-a348-0940c1561186","name":"Auth","type":"folder"}},"urlObject":{"path":["login"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"695803c8-eb71-42a8-859d-73ebc67c6ed7","name":"Login","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"email\": \"john.doe@mail.com\",\n \"password\": \"myPassword\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.livementor.com/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI3YjRiYTI4MC0yZWM4LTQ2NDAtOWI2Ni04NjRkNzc1YmM2M2YiLCJzdWIiOiIxNjM3NyIsInNjcCI6InVzZXIiLCJhdWQiOm51bGwsImlhdCI6MTYwNjQ3MDIzOCwiZXhwIjoxNjA2NTU2NjM4fQ.5MljobO5y5M1pz6MXJpQk5_6cQx3VnM85Zvwfa5vdTE"},{"key":"ETag","value":"W/\"cf4be2ece0babb9494fde5963e8f1578\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"3df5beaa-4417-45bc-85e5-4f96775d9b56"},{"key":"X-Runtime","value":"0.297337"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"jwt\": \"xxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n }\n}"}],"_postman_id":"87a65456-357a-4ae9-a9de-4be3024f9833"},{"name":"Change password","id":"6c2aed9d-5a69-4b87-9994-82a104a7db7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.livementor.com/passwords/change?current_password=myPassword&password=myNewPassword&password_confirmation=myNewPassword","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"8048e759-b982-4c3c-a348-0940c1561186","id":"8048e759-b982-4c3c-a348-0940c1561186","name":"Auth","type":"folder"}},"urlObject":{"path":["passwords","change"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

The user's current password

\n","type":"text/plain"},"key":"current_password","value":"myPassword"},{"description":{"content":"

The user's new password

\n","type":"text/plain"},"key":"password","value":"myNewPassword"},{"description":{"content":"

The user's new password again

\n","type":"text/plain"},"key":"password_confirmation","value":"myNewPassword"}],"variable":[]}},"response":[],"_postman_id":"6c2aed9d-5a69-4b87-9994-82a104a7db7e"},{"name":"Send reset password instructions","id":"003bcae2-83c2-40ca-bb8b-7dfb16d99e56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"john.doe@mail.com","description":"

Email address of the user account requesting to reset its password

\n","type":"text"},{"key":"redirect_uri","value":"https://app.livementor.com/reset_password","description":"

URI used in the instructions email to redirect the user for him/her to choose a new password

\n","type":"text"}]},"url":"https://api.livementor.com/passwords/reset","description":"

Send reset password instructions by mail to a user

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"8048e759-b982-4c3c-a348-0940c1561186","id":"8048e759-b982-4c3c-a348-0940c1561186","name":"Auth","type":"folder"}},"urlObject":{"path":["passwords","reset"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"ca75df93-cdb9-4a8c-8621-dc64c23a2518","name":"Send reset password instructions","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"john.doe@mail.com","description":"Email address of the user account requesting to reset its password","type":"text"},{"key":"redirect_uri","value":"https://app.livementor.com/reset_password","description":"URI used in the instructions email to redirect the user for him/her to choose a new password","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://api.livementor.com/passwords/reset"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Date","value":"Wed, 09 Dec 2020 08:52:20 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Etag","value":"W/\"5875a312f4eb38595370877d167ddc8f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"17e755c4-9bc9-416c-981a-7d13e36f40f1"},{"key":"X-Runtime","value":"1.183927"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": \"Reset password instructions sent\"\n}"}],"_postman_id":"003bcae2-83c2-40ca-bb8b-7dfb16d99e56"},{"name":"Reset password","id":"405df2ce-625a-4ff6-bde0-25e0817aa8ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

Unique token generated when requesting a password reset

\n","key":"reset_password_token","type":"text","value":"DkaH88xow4dAaioWC2yG"},{"description":"

The new password

\n","key":"password","type":"text","value":"MyNewPassword"},{"key":"password_confirmation","value":"MyNewPassword","description":"

A copy of the new password to avoid any typo error

\n","type":"text"}]},"url":"https://api.livementor.com/passwords","description":"

Reset user password with a reset token

Invalidare a JWT

How to login or logout.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"18974a60-ee9b-436a-9353-5fa596019420","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"472e1b86-5549-4d27-845b-66fe84794f76","type":"text/javascript","exec":[""]}}],"_postman_id":"8048e759-b982-4c3c-a348-0940c1561186"},{"name":"Absence","item":[{"name":"Retrieve absences","id":"9efee888-474f-4091-a056-ecf2053f24f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/absences?timeframes=past,present,future","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","absences"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

A comma-separated list of timeframes for filtering

\n","type":"text/plain"},"key":"timeframes","value":"past,present,future"}],"variable":[]}},"response":[{"id":"42988fef-a1fd-4464-8ccb-eeb70a64f192","name":"Index","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/absences?timeframes=present,future","host":["https://api.livementor.com"],"path":["v1","absences"],"query":[{"key":"timeframes","value":"present,future","description":"A comma-separated list of timeframes for filtering"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 2533,\n \"user_id\": 59,\n \"start_at\": \"2021-05-16T22:00:00.000Z\",\n \"end_at\": \"2021-05-24T22:00:00.000Z\",\n \"reason\": \"holiday\",\n \"timeframe\": \"future\"\n },\n {\n \"user_id\": 59,\n \"start_at\": \"2021-05-14T23:00:00.000Z\",\n \"end_at\": \"2021-05-22T23:00:00.000Z\",\n \"reason\": \"sick_leave\",\n \"timeframe\": \"present\"\n },\n {\n \"user_id\": 59,\n \"start_at\": \"2021-05-14T23:00:00.000Z\",\n \"end_at\": \"2021-05-22T23:00:00.000Z\",\n \"reason\": null,\n \"timeframe\": \"present\"\n }\n ], \n \"total_items\": 3,\n \"pagination\": {\n \"current_page\": \"/v1/absences?page=1&timeframes=past%2Cpresent\",\n \"first_page\": \"/v1/absences?page=1&timeframes=past%2Cpresent\",\n \"last_page\": \"/v1/absences?page=1&timeframes=past%2Cpresent\",\n \"next_page\":null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"9efee888-474f-4091-a056-ecf2053f24f5"},{"name":"Create absence","id":"814b9d86-9402-42e5-8f9e-80649f068000","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"start_at","value":"2021-05-05","description":"

The start date

\n","type":"text"},{"key":"end_at","value":"2021-05-25","description":"

The end date

\n","type":"text"},{"key":"reason","value":"holiday","description":"

The reason, can be 'holiday', 'sick_leave'

\n","type":"text"}]},"url":"https://api.livementor.com/v1/absences","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","absences"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"814b9d86-9402-42e5-8f9e-80649f068000"},{"name":"Delete absence","id":"1cf36a06-3d11-4204-bc23-a21f5cf0e6df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.livementor.com/v1/absences/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","absences",":id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

the identifier of the absence to delete

\n","type":"text/plain"},"type":"any","value":"4","key":"id"}]}},"response":[],"_postman_id":"1cf36a06-3d11-4204-bc23-a21f5cf0e6df"}],"id":"484d47ea-6c5e-473c-bc96-22f131d8cdfb","description":"

Absences are objects that represent mentors leaves. These endpoints only make sense for mentors because students can't have absences.

An absence contains the following informations:

an id, the identifier of the object,
\n
a start_at date,
\n
an end_at date,
\n
a reason that can be null, \"holiday\" or \"sick_leave\",
\n
a timeframe (computed) that can be \"past\", \"present\" or \"future\".
\n

\n","_postman_id":"484d47ea-6c5e-473c-bc96-22f131d8cdfb","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Actions","item":[{"name":"Retrieve actions","id":"11e0384a-d348-498f-a031-5650aaa83458","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/actions","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","actions"],"host":["https://api.livementor.com"],"query":[{"disabled":true,"key":"kind","value":"follow_up"}],"variable":[]}},"response":[{"id":"7498d995-1b62-4b98-ad0d-ccbb3b9eaec1","name":"Retrieve actions","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/actions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-bullet-console-text","value":"[\"user: nathan\\nUSE eager loading detected\\n Action =\\u003e [:mentor]\\n Add to your query: .includes([:mentor])\\nCall stack\\n /Users/nathan/Websites/LiveMentor/API/app/views/v1/actions/_action.json.jbuilder:3:in `block in _app_views_v__actions__action_json_jbuilder___4475537930075083085_75840'\\n /Users/nathan/Websites/LiveMentor/API/app/views/v1/actions/_action.json.jbuilder:2:in `_app_views_v__actions__action_json_jbuilder___4475537930075083085_75840'\\n /Users/nathan/Websites/LiveMentor/API/app/views/v1/actions/index.json.jbuilder:4:in `block in _app_views_v__actions_index_json_jbuilder__193473033967018190_75780'\\n /Users/nathan/Websites/LiveMentor/API/app/views/v1/actions/index.json.jbuilder:3:in `_app_views_v__actions_index_json_jbuilder__193473033967018190_75780'\\n /Users/nathan/Websites/LiveMentor/API/app/controllers/application_controller.rb:39:in `process_action'\\n\\n\",\"user: nathan\\nUSE eager loading detected\\n Action =\\u003e [:student]\\n Add to your query: .includes([:student])\\nCall stack\\n /Users/nathan/Websites/LiveMentor/API/app/views/v1/actions/_action.json.jbuilder:6:in `block in _app_views_v__actions__action_json_jbuilder___4475537930075083085_75840'\\n /Users/nathan/Websites/LiveMentor/API/app/views/v1/actions/_action.json.jbuilder:5:in `_app_views_v__actions__action_json_jbuilder___4475537930075083085_75840'\\n /Users/nathan/Websites/LiveMentor/API/app/views/v1/actions/index.json.jbuilder:4:in `block in _app_views_v__actions_index_json_jbuilder__193473033967018190_75780'\\n /Users/nathan/Websites/LiveMentor/API/app/views/v1/actions/index.json.jbuilder:3:in `_app_views_v__actions_index_json_jbuilder__193473033967018190_75780'\\n /Users/nathan/Websites/LiveMentor/API/app/controllers/application_controller.rb:39:in `process_action'\\n\\n\"]"},{"key":"ETag","value":"W/\"70c757cad8b4785b366bd4f5c64fd4f4\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"761d5ba6-38bf-4678-b4f9-6e0b258f2e7a"},{"key":"X-Runtime","value":"0.066876"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 6,\n \"kind\": null,\n \"status\": \"todo\",\n \"due_on\": \"2021-10-27\",\n \"training_course_id\": 8868,\n \"completed_at\": \"2021-10-26T13:24:23.860Z\",\n \"created_at\": \"2021-10-26T13:24:06.507Z\",\n \"metadata\": {\n \"conversation_id\": \"aFdLxhFaLNWrFk3yQxjD\",\n \"message_id\": \"GbOpx63HRFcEsShBgR7z\"\n },\n \"mentor\": {\n \"id\": 294733,\n \"given_name\": \"John\",\n \"family_name\": \"Mentor\",\n \"picture\": \"/system/users/avatars/000/294/733/medium/290px-Bruce_Lee_1973.jpg?1581585457\",\n \"role\": \"mentor\"\n },\n \"student\": {\n \"id\": 303533,\n \"given_name\": \"Annette\",\n \"family_name\": \"Adams\",\n \"picture\": \"/john-doe.jpg\",\n \"role\": \"student\"\n }\n }\n ],\n \"total_items\": 1,\n \"pagination\": {\n \"current_page\": \"/v1/actions?page=1\",\n \"first_page\": \"/v1/actions?page=1\",\n \"last_page\": \"/v1/actions?page=1\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"11e0384a-d348-498f-a031-5650aaa83458"},{"name":"Cancel action","id":"88b9e920-a1bd-4f95-ac42-96893a90c45d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.livementor.com/v1/actions/:id/cancel","description":"

In some extent, there are actions that cannot be processed or do not require any work from a mentor.

For instance, if a student send a \"Have a good day\" message to his/her mentor, it does not require the mentor to answer to it.

This is why it is possible to cancel an action.

Actions are tasks to be performed by mentors in the LiveMentor messagerie.

\n
\n\n

An action has a kind, which can be:

first_message: the mentor mentor should send the first message in the conversation with the student
follow_up: the mentor mentor should reply to the student

\nAn action also has a lifecycle and can go through the following statuses:

todo: the action is pending completion
done: the action has been performed
cancelled: the action was cancelled by the mentor

\n","_postman_id":"2e5892b0-b1e7-48aa-9b9d-0ce277edae78","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"AI Copilot","item":[{"name":"Retrieve AI copilot conversations","id":"f73b84c5-ffeb-43e9-932f-2392c25d81db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/ai_copilot/conversations","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","ai_copilot","conversations"],"host":["https://api.livementor.com"],"query":[{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"limit_offset","value":"50"}],"variable":[]}},"response":[{"id":"1bbcffce-a436-4bc4-9e1c-ba8f3f8822bb","name":"Retrieve AI copilot conversations","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/ai_copilot/conversations?page=1","host":["https://api.livementor.com"],"path":["v1","ai_copilot","conversations"],"query":[{"key":"page","value":"1"},{"key":"limit_offset","value":"50","disabled":true}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"conversations\": [\n {\n \"id\": 1,\n \"title\": \"Conversation on 2025-09-17 14:12\",\n \"created_at\": \"2025-09-17T16:12:25.905+02:00\",\n \"updated_at\": \"2025-09-17T16:12:25.905+02:00\",\n \"archived_at\": null,\n \"user_id\": 324046\n }\n ]\n },\n \"total_items\": 1,\n \"pagination\": {\n \"current_page\": \"/v1/ai_copilot/conversations?page=1\",\n \"first_page\": \"/v1/ai_copilot/conversations?page=1\",\n \"last_page\": \"/v1/ai_copilot/conversations?page=1\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"f73b84c5-ffeb-43e9-932f-2392c25d81db"},{"name":"Get AI copilot conversation","event":[{"listen":"test","script":{"id":"55c8aea0-a12c-49f0-a651-3113872de8a8","exec":["const json = pm.response.json();","const data = json.data;","","let template = `","","","

"," "," ${data.messages.map(msg => `","

","

"," ${msg.content}","

${new Date(msg.created_at).toLocaleString()}

","

"," `).join('')}","

","`;","","pm.visualizer.set(template, {});",""],"type":"text/javascript","packages":{}}}],"id":"b1ee2da5-77d7-4941-9600-a3fa59b6c43d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/ai_copilot/conversations/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","ai_copilot","conversations",":id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"3ca27a91-9216-47ae-bbc1-c68e6f1ad6df","name":"Get AI copilot conversation","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/ai_copilot/conversations/1"},"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 34,\n \"title\": \"Conversation du 18/09/2025 07:41\",\n \"created_at\": \"2025-09-18T09:41:54.552+02:00\",\n \"updated_at\": \"2025-09-18T09:41:54.552+02:00\",\n \"archived_at\": null,\n \"user_id\": 324046,\n \"messages\": [\n {\n \"id\": 36,\n \"role\": \"assistant\",\n \"content\": \"Définir son offre commerciale, c’est clarifier ce que vous vendez, à qui, avec quelle promesse de résultat, sous quelle forme et à quel prix, tout en prouvant que le client a raison de vous choisir. Voici une méthode simple et actionnable.\\n\\n1) Commencez par le client\\n- Cible précise (ICP/persona) : secteur, taille, budget, décisionnaire, contexte d’usage.\\n- Problèmes prioritaires et objectifs mesurables (jobs-to-be-done).\\n- Alternatives actuelles (concurrents, bricolages, statu quo).\\n- Preuves terrain : 5–10 entretiens clients pour valider douleurs, mots exacts, seuil de valeur.\\n\\n2) Formulez la proposition de valeur\\n- Pour [cible], qui [problème], nous [solution/catégorie] qui [bénéfice principal mesurable], contrairement à [alternative], nous [différenciateur clé].\\n- Quantifiez l’impact attendu (temps, coûts, revenus, risque).\\n\\n3) Structurez l’offre (packaging)\\n- Résultat promis (outcome) et indicateurs de succès.\\n- Livrables concrets + fréquence (ex: 12 posts/mois, audit, déploiement).\\n- Périmètre et exclusions pour éviter l’ambiguïté.\\n- Niveaux d’offre (2–3 paliers clairs) et options.\\n- Délais, jalons, modalités d’exécution (SLA, support).\\n- Bonus et éléments de valeur perçue (onboarding, template, formation).\\n- Réduction du risque: essai, garantie, paiement fractionné.\\n\\n4) Fixez le prix intelligemment\\n- Modèle: forfait, abonnement, usage, performance, licence.\\n- Stratégie: orientée valeur (WTP), alignée marché, ou pénétration.\\n- Points d’ancrage: prix de l’alternative, valeur créée, coût de l’inaction.\\n- Unités d’économie: coûts directs, capacité, marge brute, seuil de rentabilité.\\n- Termes: engagement, acompte, remises conditionnelles, indexation.\\n- Testez 2–3 paliers avec avantages différenciés (évitez les micro-différences).\\n\\n5) Rassurez et prouvez\\n- Études de cas, témoignages, références, chiffres avant/après.\\n- Démonstration, POC, essai gratuit limité.\\n- Certifications, partenariats, presse.\\n- Garantie claire (partielle, conditions définies).\\n\\n6) Message et positionnement\\n- Titre clair orienté résultat; 3 bénéfices clés; “comment ça marche” en 3 étapes.\\n- Réponses aux objections (prix, risque, délai, intégration).\\n- Appel à l’action concret (réserver un audit, démarrer l’essai).\\n\\n7) Go-to-market et process de vente\\n- Canaux d’acquisition prioritaires (1–2 au départ): outbound ciblé, contenu, partenariats, événements, publicité.\\n- Étapes: qualification → diagnostic → proposition → closing → onboarding.\\n- Outils: une page d’offre, script de découverte, modèle de proposition chiffrée.\\n\\n8) Mesurez et itérez\\n- KPI: taux de conversion, panier moyen, CAC, marge, churn/retention, NPS.\\n- Expériences rapides: “fake door” sur landing page, préventes, pilote payant.\\n\\nCadre pour rendre l’offre “irrésistible” (utile pour prioriser)\\n- Augmentez le résultat désiré et la probabilité perçue d’y arriver (preuves, garanties).\\n- Réduisez le délai et l’effort/sacrifice perçu (onboarding, done-for-you, automatisation).\\n\\nExemple express (service B2B: gestion réseaux sociaux pour restaurants)\\n- Cible: restos 3–10 salariés en centre-ville, pas de CM dédié, besoin de réservations en heures creuses.\\n- Promesse: +15% de réservations en 90 jours, sinon 50% remboursé.\\n- Livrables: calendrier éditorial; 12 posts/mois; 2 campagnes pubs/mois; réponses aux avis; reporting mensuel.\\n- Paliers:\\n - Essentiel 490 €/mois (1 zone, 1 plateforme).\\n - Croissance 890 €/mois (2 plateformes, UGC, 300 € ads inclus).\\n - Setup: 300 €, engagement 3 mois.\\n- Preuves: 3 cas clients, screenshots réservations.\\n- Prochain pas: audit gratuit 30 min et devis sous 24h.\\n\\nModèle de fiche d’offre (copiez/collez et complétez)\\n- Pour qui: …\\n- Problème prioritaire: …\\n- Promesse/résultat: …\\n- Ce que vous obtenez: …\\n- Ce qui n’est pas inclus: …\\n- Délais et étapes: …\\n- Preuves: …\\n- Garantie/essai: …\\n- Prix et plans: …\\n- Condition et modalités: …\\n- Prochain pas (CTA): …\\n\\nErreurs courantes à éviter\\n- Parler de fonctionnalités plutôt que de résultats.\\n- Cible trop large; offre fourre-tout.\\n- Prix trop bas pour “rassurer”, qui tue la marge et la qualité.\\n- Pas de périmètre ni d’exclusions, source de dérives.\\n- Absence de preuves et de réduction du risque.\\n\\nSi vous me dites votre secteur, B2B/B2C, type de client, résultat promis et fourchette de prix envisagée, je vous aide à rédiger une offre précise en 10 lignes et un devis type.\",\n \"files\": [\n { \"id\": \"file-Mdaa5eJk6jDv45xZwt86hS\", \"name\": \"test.pdf\", \"expires_at\": null }\n ],\n \"created_at\": \"2025-09-18T09:43:14.164+02:00\",\n \"updated_at\": \"2025-09-18T09:43:14.164+02:00\",\n },\n {\n \"id\": 35,\n \"role\": \"user\",\n \"content\": \"Comment définit-on son offre commercial ?\",\n \"files\": [],\n \"created_at\": \"2025-09-18T09:41:54.621+02:00\",\n \"updated_at\": \"2025-09-18T09:41:54.621+02:00\"\n }\n ]\n }\n}"}],"_postman_id":"b1ee2da5-77d7-4941-9600-a3fa59b6c43d"},{"name":"Retrieve AI copilot messages","id":"33bfe32a-6b22-41bb-b2e7-f4a0c32ff213","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/ai_copilot/messages?conversation_id=1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","ai_copilot","messages"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

ID of the conversation to retrieve messages from

\n","type":"text/plain"},"key":"conversation_id","value":"1"},{"disabled":true,"description":{"content":"

Optional: Exclude messages with this ID and newer

\n","type":"text/plain"},"key":"message_offset_id","value":""},{"disabled":true,"description":{"content":"

Number of messages to retrieve (default: 50)

\n","type":"text/plain"},"key":"limit_offset","value":"50"}],"variable":[]}},"response":[{"id":"e75783e2-e986-4459-a190-527c1dba07f9","name":"Retrieve AI copilot messages","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/ai_copilot/messages?conversation_id=1","host":["https://api.livementor.com"],"path":["v1","ai_copilot","messages"],"query":[{"key":"conversation_id","value":"1","description":"ID of the conversation to retrieve messages from"},{"key":"message_offset_id","value":"","description":"Optional: Exclude messages with this ID and newer","disabled":true},{"key":"limit_offset","value":"50","description":"Number of messages to retrieve (default: 50)","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"33bfe32a-6b22-41bb-b2e7-f4a0c32ff213"},{"name":"Create AI copilot message","event":[{"listen":"test","script":{"id":"197b2912-2071-46c6-b138-f279fac8874e","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"4573f4e3-9c92-4bf2-8c11-3d25e0b61d92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"message[content]","value":"Que penses tu de mon prévisionnel ?","type":"text","uuid":"aead32b8-2725-4c78-b911-cc9392be1b29"},{"key":"message[attachments][]","type":"file","uuid":"d6330a6a-48c2-489f-b37f-a426623ed2cf","value":null}]},"url":"https://api.livementor.com/v1/ai_copilot/messages","description":"

Call this endpoint to make a request to our AI copilot.

conversation_id is optional here, if there is no conversation_id, this message will create a new conversation.

Attachments
- Maximum 3 files attached to a message
- Maximum 10Mo for a file
- Accepted formats : pdf, jpg, jpeg, png

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","ai_copilot","messages"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"c01af0af-0556-47bf-aac6-b7a843ecbcfd","name":"New conversation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": {\n \"content\": \"Hello, I need help with my project\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.livementor.com/v1/ai_copilot/messages"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Length","value":"788"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Etag","value":"W/\"5c895c8ade97146938eee15df6894290\""},{"key":"Nel","value":"{\"report_to\":\"heroku-nel\",\"response_headers\":[\"Via\"],\"max_age\":3600,\"success_fraction\":0.01,\"failure_fraction\":0.1}"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Report-To","value":"{\"group\":\"heroku-nel\",\"endpoints\":[{\"url\":\"https://nel.heroku.com/reports?s=IG3UzJAO9cI73OY5WfaX84MvHCHTsIjS1s7AZsHIZ8w%3D\\u0026sid=812dcc77-0bd0-43b1-a5f1-b25750382959\\u0026ts=1758118345\"}],\"max_age\":3600}"},{"key":"Reporting-Endpoints","value":"heroku-nel=\"https://nel.heroku.com/reports?s=IG3UzJAO9cI73OY5WfaX84MvHCHTsIjS1s7AZsHIZ8w%3D&sid=812dcc77-0bd0-43b1-a5f1-b25750382959&ts=1758118345\""},{"key":"Server","value":"Heroku"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains"},{"key":"Vary","value":"Origin"},{"key":"Via","value":"1.1 heroku-router"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-Request-Id","value":"fc947bc9-6a77-4f45-5daf-be56fae1ac8d"},{"key":"X-Runtime","value":"10.247047"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Date","value":"Wed, 17 Sep 2025 14:12:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"status\": \"processing\",\n \"conversation_id\": 67\n }\n}"},{"id":"c44049f2-92bb-417a-a814-c1f5170224ed","name":"New message on an existing conversation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": {\n \"content\": \"Peux tu réexpliquer, je n'ai pas compris\",\n \"conversation_id\": 166\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.livementor.com/v1/ai_copilot/messages"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"status\": \"processing\",\n \"conversation_id\": 166\n }\n}"},{"id":"e58a65da-14e2-42f3-83d8-d0ef26f04a3d","name":"New message with attachments","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"message[content]","value":"Peux-tu me faire en feedback sur ce travail stp","type":"text","uuid":"26c48138-94ad-4eb2-872a-e31368e6718d"},{"key":"message[attachments][]","type":"file","uuid":"7214ab1b-000d-4b97-9b49-2e1fbd23294f","value":null},{"key":"message[conversation_id]","value":"106","type":"text","uuid":"d930ee3f-6cef-41ed-845c-4262102fd4b7"}],"options":{"raw":{"language":"json"}}},"url":"https://api.livementor.com/v1/ai_copilot/messages"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"status\": \"processing\",\n \"conversation_id\": 166\n }\n}"}],"_postman_id":"4573f4e3-9c92-4bf2-8c11-3d25e0b61d92"},{"name":"Update AI copilot message","id":"a542ee5b-54b1-4ee7-9420-35640ba96c93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": {\n \"helpful\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.livementor.com/v1/ai_copilot/messages/:id","description":"

- helpful can be be true, false, null.

The file will be soft deleted, which means the file is deleted from OpenAI, then the expires_at field will be filled with current time.

AI Copilot endpoints for managing conversations and messages with the AI assistant.

\n","_postman_id":"c4a859f7-b440-400d-95c3-7fcc14911664","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Assessment","item":[{"name":"Retrieve user assessments for a given certification","id":"15c6d252-274f-442c-9b7b-ae0a116d6d0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/assessments?certification_id=1234&with_exercises_only=true","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","assessments"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

Certification id

\n","type":"text/plain"},"key":"certification_id","value":"1234"},{"description":{"content":"

Specifies if we want to retrieve only assessments linked to an exercise

\n","type":"text/plain"},"key":"with_exercises_only","value":"true"}],"variable":[]}},"response":[{"id":"3d6fecdf-0aa4-46a8-9fa7-9bf980fb73ed","name":"Retrieve user assessments for a given certification","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/assessments?certification_id=1234&with_exercises_only=true","host":["https://api.livementor.com"],"path":["v1","assessments"],"query":[{"key":"certification_id","value":"1234","description":"Certification id"},{"key":"with_exercises_only","value":"true","description":"Specifies if we want to retrieve only assessments linked to an exercise"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"certification_id\": 1234,\n \"skill\": {\n \"id\": 1,\n \"exercise\": {\n \"title\": \"Ma carte empathique\",\n \"files\": [\n {\n \"id\": 1,\n \"name\": \"carte0123.pdf\",\n \"url\": \"https://hellomentor.s3.amazonaws.com/assessments_files/carte0123.pdf\"\n }\n ]\n }\n }\n },\n {\n \"id\": 2,\n \"certification_id\": 1234,\n \"skill\": {\n \"id\": 2,\n \"exercise\": {\n \"title\": \"Mon contenu rédactionnel\",\n \"files\": []\n }\n }\n },\n {\n \"id\": 5,\n \"certification_id\": 1234,\n \"skill\": {\n \"id\": 3,\n \"exercise\": {\n \"title\": \"Mon visuel de communication\",\n \"files\": [\n {\n \"id\": 2,\n \"name\": \"visuel0123.pdf\",\n \"url\": \"https://hellomentor.s3.amazonaws.com/assessments_files/visuel0123.pdf\"\n }\n ]\n }\n }\n }\n ]\n}"}],"_postman_id":"15c6d252-274f-442c-9b7b-ae0a116d6d0e"},{"name":"Add file","id":"06b90e29-5a8c-49c5-950e-59e24cedf7a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.livementor.com/v1/assessments/:id/files","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","assessments",":id","files"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

Assessment id

\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[{"id":"15f071cb-927a-471e-a263-1ae0c5802a4c","name":"File added","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}],"options":{"raw":{"language":"json"}}},"url":"https://api.livementor.com/v1/assessments/123/files"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"file\": [\n {\n \"id\": 1,\n \"name\": \"carte0123.pdf\",\n \"url\": \"https://hellomentor.s3.amazonaws.com/assessments_files/carte0123.pdf\"\n }\n ]\n }\n}"},{"id":"db8b109e-d6eb-463a-817f-91767e4dd4ae","name":"Error when adding file","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":"https://api.livementor.com/v1/assessments/123/files"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": \"Error when trying to upload file\"\n}"}],"_postman_id":"06b90e29-5a8c-49c5-950e-59e24cedf7a5"},{"name":"Delete file","id":"10579e10-8031-49eb-b835-f3e885dd8260","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.livementor.com/v1/assessments/:assessment_id/files/:file_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","assessments",":assessment_id","files",":file_id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

Assessment id

\n","type":"text/plain"},"type":"any","value":null,"key":"assessment_id"},{"description":{"content":"

File id

\n","type":"text/plain"},"type":"any","value":null,"key":"file_id"}]}},"response":[{"id":"f61742d1-6d80-4fd9-965f-7a5ec643c323","name":"Delete file","originalRequest":{"method":"DELETE","header":[],"url":"https://api.livementor.com/v1/assessments/123/files/1"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": \"File deleted\"\n}"}],"_postman_id":"10579e10-8031-49eb-b835-f3e885dd8260"}],"id":"f4d15ffa-3a0d-4938-8dcb-181cd640a7b0","description":"

An Assessment represents a student evaluation for 1 question (= 1 skill). It contains the following information:

certification_id
skill_id
status , which can be either pending, acquiredor non_acquired
comments
notes

\n","_postman_id":"f4d15ffa-3a0d-4938-8dcb-181cd640a7b0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Bonus","item":[{"name":"Retrieve bonuses","id":"74ae5624-7cca-4006-a464-ff46883bc977","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/bonus?masterclasses=&modules=&bonus=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","bonus"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

(optional) a list of masterclass ids used as a filter

\n","type":"text/plain"},"key":"masterclasses","value":""},{"description":{"content":"

(optional) a list of module ids used as a filter

\n","type":"text/plain"},"key":"modules","value":""},{"description":{"content":"

(optional) a list of bonus ids used as a filter

\n","type":"text/plain"},"key":"bonus","value":""}],"variable":[]}},"response":[{"id":"df0fab71-b5c1-415b-9d72-9473df52656b","name":"Index","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/bonus?bonus=1324,1334","host":["https://api.livementor.com"],"path":["v1","bonus"],"query":[{"key":"bonus","value":"1324,1334"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1324,\n \"title\": \"Activité : les comptes qui m'inspirent\"\n },\n {\n \"id\": 1334,\n \"title\": \"Les règles du jeu sur Instagram\"\n }\n ]\n}"}],"_postman_id":"74ae5624-7cca-4006-a464-ff46883bc977"},{"name":"Retrieve a bonus","id":"a456a890-018b-4a6b-8b8a-7024af05b9cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/bonus/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","bonus",":id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

the identifier of the bonus

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8783b45f-ae67-47f2-b72a-935091eb482c","name":"Show","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/bonus/1324"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1324,\n \"title\": \"Activité : les comptes qui m'inspirent\",\n \"description\": null,\n \"video_url\": null,\n \"document_url\": \"/resources/Bonus-Activite-1.pdf\",\n \"discourse_topic_id\": null\n }\n}"}],"_postman_id":"a456a890-018b-4a6b-8b8a-7024af05b9cd"}],"id":"7cc74d35-d8a4-4160-8153-b470617cd485","description":"

Bonuses are additional content that can be found at the end of a module.

A bonus has the same structure as a lesson and contains the following informations:

a title,
a description,
the video_url,
the document_url,
the discourse_topic_id.

Please refer to the Lesson section for examples.

\n","_postman_id":"7cc74d35-d8a4-4160-8153-b470617cd485","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Calendar Synchronization","item":[{"name":"Retrieve calendar synchronization information","id":"6d2f9d25-4534-4bef-baf2-d7050dc361ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/calendar_sync","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","calendar_sync"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"8a0460c3-3758-4b44-930b-5b76104107df","name":"Mentor with a synchronized calendar","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/calendar_sync"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"accounts\": [\n {\n \"provider\": \"google\",\n \"provider_id\": \"michel.dupont@livementor.com\",\n \"last_sync\": \"2021-08-24T16:40:53+0200\",\n \"exception\": null,\n \"error\": null,\n \"error_at\": null\n }\n ],\n \"calendars\": [\n {\n \"id\": \"f2fa1588-45b4-4184-a777-18d68b81de51\",\n \"provider\": \"google\",\n \"provider_id\": \"c_tsd7429f87290fdds930@group.calendar.google.com\",\n \"provider_sync\": true,\n \"name\": \"Bookings\",\n \"description\": \"Created by Timekit on resource creation\"\n },\n {\n \"id\": \"4d0a5c06-0798-46a4-8349-059a0fd535f3\",\n \"provider\": \"google\",\n \"provider_id\": \"michel.dupont@livementor.com\",\n \"provider_sync\": true,\n \"name\": \"michel.dupont@livementor.com\",\n \"description\": null\n },\n {\n \"id\": \"80f3defb-3274-406a-99d3-5b05289bacd7\",\n \"provider\": \"google\",\n \"provider_id\": \"fr.french#holiday@group.v.calendar.google.com\",\n \"provider_sync\": false,\n \"name\": \"Jours fériés en France\",\n \"description\": \"Jours fériés et fêtes légales en France\"\n }\n ]\n }\n}"},{"id":"397705e3-c3fd-4976-b0bc-f74325c319d8","name":"Mentor with no synchronized calendar","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/calendar_sync"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"accounts\": [],\n \"calendars\": [\n {\n \"id\": \"15055cb9-c184-46c3-867d-8c4312025a81\",\n \"provider\": \"timekit\",\n \"provider_id\": null,\n \"provider_sync\": false,\n \"name\": \"Bookings\",\n \"description\": \"Created by Timekit on resource creation\"\n }\n ]\n }\n}"}],"_postman_id":"6d2f9d25-4534-4bef-baf2-d7050dc361ea"},{"name":"Update calendar synchronization","id":"9da8401e-cbe6-4d6d-9771-a7f0f091bdf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"calendar_id","value":"363b1076-a01c-446c-8fd2-e26d4e1c56cc","description":"

A UUID that identifies the calendar

\n","type":"text"},{"key":"sync","value":"true","description":"

A boolean that is true if we want to enable synchronization on this calendar, false otherwise.

\n","type":"text"}]},"url":"https://api.livementor.com/v1/calendar_sync","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","calendar_sync"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"a019d8a6-1e1d-4b77-b25a-fce199ebb375","name":"Update","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"calendar_id","value":"363b1076-a01c-446c-8fd2-e26d4e1c56cc","description":"A UUID that identifies the calendar","type":"text"},{"key":"sync","value":"true","description":"A boolean that is true if we want to enable synchronization on this calendar, false otherwise.","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://api.livementor.com/v1/calendar_sync"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": true\n}"}],"_postman_id":"9da8401e-cbe6-4d6d-9771-a7f0f091bdf7"},{"name":"Switch the timekit_id of a mentor","id":"f1431672-3b93-4cf4-8556-72129f235355","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"timekit_id","value":"6c70df82-8d9e-4659-905e-af76c830f1d2","description":"

The new timekit_id to switch with

\n","type":"text"}]},"url":"https://api.livementor.com/v1/calendar_sync/switch","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","calendar_sync","switch"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"bf199321-a950-4482-b833-e6fb0e60d32e","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"timekit_id","value":"6c70df82-8d9e-4659-905e-af76c830f1d2","description":"The new timekit_id to switch with","type":"text"}]},"url":"https://api.livementor.com/v1/calendar_sync/switch"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{ \n \"data\": {\n \"done\": true\n }\n}"},{"id":"67562cad-acb6-4cf9-ac4e-14ba1e7820b5","name":"Current timekit resource has future bookings","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"timekit_id","value":"6c70df82-8d9e-4659-905e-af76c830f1d2","description":"The new timekit_id to switch with","type":"text"}]},"url":"https://api.livementor.com/v1/calendar_sync/switch"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"done\": false,\n \"reason\": \"has_future_bookings\"\n }\n}"},{"id":"89da6a42-578a-4294-93ac-464144bc5c8b","name":"New timekit_id does not exist","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"timekit_id","value":"6c70df82-8d9e-4659-905e-af76c830f1d2","description":"The new timekit_id to switch with","type":"text"}]},"url":"https://api.livementor.com/v1/calendar_sync/switch"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"done\": false,\n \"reason\": \"new_timekit_id_does_not_exist\"\n }\n}"}],"_postman_id":"f1431672-3b93-4cf4-8556-72129f235355"},{"name":"Synchronize all calendars now","id":"e513735d-cdb1-49c4-b23e-d5769cafdd0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.livementor.com/v1/calendar_sync/sync_now","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","calendar_sync","sync_now"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"10d611a2-71d2-412a-9f75-8135f3031d17","name":"Synchronize","originalRequest":{"method":"PUT","header":[],"url":"https://api.livementor.com/v1/calendar_sync/sync_now"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"description\": \"Synced 0 events\",\n \"count\": 0\n }\n}"}],"_postman_id":"e513735d-cdb1-49c4-b23e-d5769cafdd0d"}],"id":"98cea2e7-f34d-49d7-9521-68df4a62b6e5","description":"

Mentors can synchronize a Google Calendar account with their account. This feature allows Timekit to better check the mentor availability when booking a coaching.

These endpoints return information about the synchronized Google Calendar accounts and the available calendars of these accounts.

Accounts are listed in the \"accounts\" array, and for each account, we can find:

the provider, that can only be 'google' since it is the only supported provider,
the provider_id, to identify the account in the \"calendars\" array,
the last_sync datetime.

Calendars are listed in the \"calendars\" array. They can either match an account listed above, or be linked to the \"timekit\" provider. They also have the following attributes:

provider and provider_id to match the corresponding account,
provider_sync, a boolean that is true if the calendar is used to check availability,
name and description, that are human readable strings to display the account.

\n","_postman_id":"98cea2e7-f34d-49d7-9521-68df4a62b6e5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Certification","item":[{"name":"Retrieve certifications","id":"67665542-400f-4cab-8031-a474611200c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/certifications?student=123456","description":"

List certifications of the authenticated user

Identifier of the student to filter on

\n","type":"text/plain"},"key":"student","value":"123456"}],"variable":[]}},"response":[{"id":"67d5c7f7-5612-4607-9524-fb0919b147d5","name":"Index","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/certifications?student=123456","host":["https://api.livementor.com"],"path":["v1","certifications"],"query":[{"key":"student","value":"123456","description":"Identifier of the student to filter on"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"1c7bbb48b07f45f0b4281b2a9f02a6df\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"437867c6-f6cd-46bc-9348-0e9cf28ff126"},{"key":"X-Runtime","value":"0.190910"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 123,\n \"version\": \"computed\",\n \"user_id\": 123456,\n \"training_course_id\": 456,\n \"limit_date\": \"2020-06-16T22:01:00.000Z\",\n \"passed\": true,\n \"status\": \"passed\",\n \"coaching_id\": 6789,\n \"masterclass\": {\n \"id\": 1,\n \"title\": \"Vasco de Gama\"\n },\n \"quizzes\": [\n {\n \"id\": 1,\n \"kind\": \"mcq\",\n \"title\": \"QCM Vasco de Gama\",\n \"url\": \"https://hellomentor-staging.herokuapp.com/app/quizzes/attempt?masterclass_id=102&kind=mcq\"\n }\n ],\n \"quizz_attempts\": [\n {\n \"quiz_id\": 1,\n \"kind\": \"mcq\",\n \"score\": 9,\n \"passed\": true,\n \"reviewer\": null,\n \"submitted_at\": \"2021-07-29T12:01:46.000Z\"\n },\n {\n \"quiz_id\": 82,\n \"kind\": \"student_evaluation\",\n \"score\": 4,\n \"passed\": true,\n \"reviewer\": 297543,\n \"submitted_at\": \"2021-08-09T07:23:45.000Z\"\n }\n ]\n }\n ],\n \"total_items\": 1,\n \"pagination\": {\n \"current_page\": \"/v1/certifications?page=1&student=123456\",\n \"first_page\": \"/v1/certifications?page=1&student=123456\",\n \"last_page\": \"/v1/certifications?page=1&student=123456\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"67665542-400f-4cab-8031-a474611200c5"}],"id":"3b8e6367-0c6d-4bb9-a18c-ea09a4240692","description":"

All students following a training course can be certified.

A certification is a token of proving that a student acquired some competences during his/her training course.

We are currently supporting two kind of certifications:

computed: the student evaluate himself/herself with a MCQ and the mentor evaluate the student. The certification result is then automatically computed. More information here
commission: the student is evaluated by his/her mentor. Then, the evaluation go through a commission deciding on the output of the certification.

A certification has a status. Available values are:

pending: the student is not done yet with his/her certification
passed: the student did his/her certification and passed
failed: the student did his/her certification and failed

\n
\nAll attempts to get certified are expressed through quiz attempts.\nA quizz is a Typeform and we currently support the following kind of quizzes:\n\n

mcq: the student evaluates himself/herself with a Multiple Choice Questions exams. The note is automatically computed
student_evaluation: the mentor evaluates the student he/she is coaching
exercice: the student worked on an assignment and upload his/her deliverable (file, text, ...)

\nNotes: passed attribute is deprecated in favour of status attribute

\n","event":[{"listen":"prerequest","script":{"id":"469676f3-3f90-420c-b53d-6c12b50b8fa7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7d197c01-c884-46f8-9893-95465d035849","type":"text/javascript","exec":[""]}}],"_postman_id":"3b8e6367-0c6d-4bb9-a18c-ea09a4240692","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Chat","item":[{"name":"Message","item":[{"name":"Index messages with conversation id","id":"8f0fe9d2-c217-4ff0-87dc-e64f6d833b87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"37f071b1-c123-474e-a98f-1742175bb1ba","id":"37f071b1-c123-474e-a98f-1742175bb1ba","name":"Message","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"8f0fe9d2-c217-4ff0-87dc-e64f6d833b87"},{"name":"Create message","id":"117d434f-c325-4d83-bc37-9afc9e89ebcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"37f071b1-c123-474e-a98f-1742175bb1ba","id":"37f071b1-c123-474e-a98f-1742175bb1ba","name":"Message","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"117d434f-c325-4d83-bc37-9afc9e89ebcc"}],"id":"37f071b1-c123-474e-a98f-1742175bb1ba","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"066fc287-291f-44a7-a11e-ca239be8f17e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aa6504c6-f0a9-47b0-b012-b949c67e621e","type":"text/javascript","exec":[""]}}],"_postman_id":"37f071b1-c123-474e-a98f-1742175bb1ba","description":""},{"name":"Upload asset","id":"6245dde2-8a10-419d-b5db-e0345fbb8a4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"description":"

[required] The file to upload

\n","key":"asset[file]","type":"file","src":"/Users/romain/Pictures/image.jpeg"}]},"url":"https://api.livementor.com/v1/chat/assets","description":"

Upload a file to the chat AWS S3 bucket.

The asset can then be displayed and downloaded from the chat.

All data related to the internal chat are stored and managed in another data layer (Firebase).

See https://github.com/livementor/lm-chat for more information.

This API is however exposing a few endpoints to interact with chat data

\n","event":[{"listen":"prerequest","script":{"id":"e2357e0e-97b6-4cf5-a590-3b21c15025ab","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ba37b37e-d173-422f-94e7-a024e7945e28","type":"text/javascript","exec":[""]}}],"_postman_id":"0b2862a1-8943-4489-a2dc-da1681416f2a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Coaching","item":[{"name":"Retrieve coachings","id":"4932c591-67ac-4deb-aa79-9f6ad1b2f6a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/coachings?context=kickoff&mentor=456789&student=123456&training_course=1&status=confirmed&starting_after=2020-05-01&ending_before=2021-02-22&limit_offset=10&page=1","description":"

Get a list of coachings

Coachings context

\n","type":"text/plain"},"key":"context","value":"kickoff"},{"description":{"content":"

Identifier of the mentor delivering the coachings

\n","type":"text/plain"},"key":"mentor","value":"456789"},{"description":{"content":"

Identifier of the student receiving the coachings

\n","type":"text/plain"},"key":"student","value":"123456"},{"description":{"content":"

Identifier of the training course to wich the coachings are linked

\n","type":"text/plain"},"key":"training_course","value":"1"},{"description":{"content":"

Current state of the coachings

\n","type":"text/plain"},"key":"status","value":"confirmed"},{"description":{"content":"

Only return coachings starting after the given date

\n","type":"text/plain"},"key":"starting_after","value":"2020-05-01"},{"description":{"content":"

Only return coachings ending before the given date

\n","type":"text/plain"},"key":"ending_before","value":"2021-02-22"},{"description":{"content":"

A limit on the number of objects to be returned per page. Limit can range between 1 and 100, and the default is 50.

\n","type":"text/plain"},"key":"limit_offset","value":"10"},{"description":{"content":"

Page number

\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"88ad7fa2-d5b6-41c6-803c-b04d4879955c","name":"Retrieve coachings","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/coachings?context=kickoff&mentor=456789&student=123456&training_course=1&status=confirmed&starting_after=2020-05-01&ending_before=2021-02-22","host":["https://api.livementor.com"],"path":["v1","coachings"],"query":[{"key":"context","value":"kickoff"},{"key":"mentor","value":"456789"},{"key":"student","value":"123456"},{"key":"training_course","value":"1"},{"key":"status","value":"confirmed"},{"key":"starting_after","value":"2020-05-01"},{"key":"ending_before","value":"2021-02-22"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"59f612a99ba3e4de9af15c55c279f34e\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"ef6afbc3-da16-40f2-8a67-fe538afd7880"},{"key":"X-Runtime","value":"0.155020"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"confirmed_no_show_at\": null,\n \"id\": 123,\n \"start_date\": \"2020-11-10T09:30:00.000Z\",\n \"end_date\": \"2020-11-10T10:00:00.000Z\",\n \"status\": \"confirmed\",\n \"timekit_id\": \"92d7148d-6ba8-487f-85a9-31a824232484\",\n \"zoom_id\": null,\n \"replay_url\": null,\n \"replay_deleted_at\": null,\n \"stop_asking_feedback_at\": null,\n \"zoom_start_url\": null,\n \"context\": \"kickoff\",\n \"student\": {\n \"id\": 123456,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n },\n \"mentor\": {\n \"id\": 456789,\n \"first_name\": \"Camille C...\",\n \"last_name\": \"\",\n \"picture\": \"/system/users/avatars/000/295/829/large/18491768_10213656284540403_3878121907613048145_o_copie.jpg?1584350318\"\n },\n \"training_course\": {\n \"id\": 1234\n }\n }\n ],\n \"total_items\": 1,\n \"pagination\": {\n \"current_page\": \"/v1/coachings?context=kickoff&ending_before=2021-02-22&mentor=456789&page=1&starting_after=2020-05-01&status=confirmed&student=123456&training_course=1\",\n \"first_page\": \"/v1/coachings?context=kickoff&ending_before=2021-02-22&mentor=456789&page=1&starting_after=2020-05-01&status=confirmed&student=123456&training_course=1\",\n \"last_page\": \"/v1/coachings?context=kickoff&ending_before=2021-02-22&mentor=456789&page=1&starting_after=2020-05-01&status=confirmed&student=123456&training_course=1\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"4932c591-67ac-4deb-aa79-9f6ad1b2f6a3"},{"name":"Create a coaching","id":"caeb6777-e086-4d41-814a-fad88002caa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"start","value":"2021-01-02T14:00:00+02:00","description":"

Coaching start time

\n","type":"text"},{"key":"end","value":"2021-01-02T14:30:00+02:00","description":"

Coaching end time

\n","type":"text"},{"key":"mentor_id","value":"99458","description":"

Identifier of the mentor delivering the coaching

\n","type":"text"},{"key":"student_id","value":"32815","description":"

Identifier of the student receiving the coaching

\n","type":"text"},{"key":"training_course_id","value":"1","description":"

Identifier of the training course for which the coahcing is created

\n","type":"text"},{"key":"context","value":"regular","description":"

Coaching context

\n","type":"text"},{"key":"certification","value":"1","description":"

Id of the certification the coaching will be linked to (only for certification_exam coaching context)

\n","type":"text"}]},"url":"https://api.livementor.com/v1/coachings","description":"

Create a new coaching, send a confirmation email and chat notification to the student.

New coaching start time

\n","key":"start","type":"text","value":"2021-01-04T14:00:00+02:00"},{"description":"

New coaching end time

\n","key":"end","type":"text","value":"2021-01-04T14:30:00+02:00"}]},"url":"https://api.livementor.com/v1/coachings/:id/reschedule","description":"

Reschedule a confirmed coaching.

When the student reschedules the coaching the coaching status will be rescheduled_by_customer.

When the coaching is cancelled by annyone else, the coaching status will be rescheduled.

In any case, the rescheduled coaching is in an ended state.\nA new coaching with new times is created.

A confirmation email is sent to the student.

Identifier of the coaching to reschedule

\n","type":"text/plain"},"type":"any","value":"30007","key":"id"}]}},"response":[{"id":"403d83bc-f4f1-4805-b175-652840ec876f","name":"Reschedule a coaching","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"description":"New coaching start time","key":"start","type":"text","value":"2021-01-04T14:00:00+02:00"},{"description":"New coaching end time","key":"end","type":"text","value":"2021-01-04T14:30:00+02:00"}]},"url":{"raw":"https://api.livementor.com/v1/coachings/:id/reschedule","host":["https://api.livementor.com"],"path":["v1","coachings",":id","reschedule"],"variable":[{"key":"id","value":"30007"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"c888fcdc7aa49f3a9af2341b8743003f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"681c64e9-ad7e-45cb-b3a5-233a6074d8e7"},{"key":"X-Runtime","value":"5.923737"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 30008,\n \"student_id\": 246747,\n \"mentor_id\": 11915,\n \"start_date\": \"2021-01-04T12:00:00.000Z\",\n \"end_date\": \"2021-01-04T12:30:00.000Z\",\n \"status\": \"confirmed\",\n \"timekit_id\": \"0baed42b-7248-4bf5-b432-ec27cfa62179\",\n \"zoom_id\": null,\n \"replay_url\": null,\n \"created_at\": \"2020-12-04T09:09:03.442Z\",\n \"updated_at\": \"2020-12-04T09:09:03.442Z\",\n \"stop_asking_feedback_at\": null,\n \"zoom_start_url\": null,\n \"context\": \"regular\",\n \"training_course_id\": 1,\n \"confirmed_no_show_at\": null\n }\n}"}],"_postman_id":"6cb96d03-52de-4f86-a645-95520e4d9635"},{"name":"Cancel a coaching","id":"a5404743-4425-4c89-8294-669fe794ebe1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.livementor.com/v1/coachings/:id/cancel","description":"

Cancel a confirmed coaching.

When the student cancels the coaching the new coaching status will be cancelled_by_customer.

When the coaching is cancelled by annyone else, the new coaching status will be cancelled

Identifier of the coaching to cancel

\n","type":"text/plain"},"type":"any","value":"30009","key":"id"}]}},"response":[{"id":"236bb5aa-79c6-4bcd-9cb4-d2d860ce7f5a","name":"Cancel a coaching","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.livementor.com/v1/coachings/:id/cancel","host":["https://api.livementor.com"],"path":["v1","coachings",":id","cancel"],"variable":[{"key":"id","value":"30009"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"ea7d1335413a3590f01c8f94087d3457\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"1a2cd2c3-706d-45eb-9943-1008f428fd90"},{"key":"X-Runtime","value":"3.706605"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 30009,\n \"student_id\": 32815,\n \"mentor_id\": 99458,\n \"start_date\": \"2021-01-08T12:00:00.000Z\",\n \"end_date\": \"2021-01-08T12:30:00.000Z\",\n \"status\": \"cancelled\",\n \"timekit_id\": \"6d45a040-b57c-4220-9d3b-a96c2f96b88e\",\n \"zoom_id\": null,\n \"replay_url\": null,\n \"created_at\": \"2020-12-04T09:12:32.317Z\",\n \"updated_at\": \"2020-12-04T09:12:46.145Z\",\n \"stop_asking_feedback_at\": null,\n \"zoom_start_url\": null,\n \"context\": \"regular\",\n \"training_course_id\": 1,\n \"confirmed_no_show_at\": null\n }\n}"}],"_postman_id":"a5404743-4425-4c89-8294-669fe794ebe1"},{"name":"Complete a coaching","id":"9f2fbf44-9703-4649-945c-ecd122488c35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.livementor.com/v1/coachings/:id/complete","description":"

Complete a coaching.

Identifier of the coaching to cancel

\n","type":"text/plain"},"type":"any","value":"33699","key":"id"}]}},"response":[{"id":"448eaf23-ddf3-4666-8d50-a7be042ec23a","name":"Complete a coaching","originalRequest":{"method":"PUT","header":[],"url":{"raw":"https://api.livementor.com/v1/coachings/:id/complete","host":["https://api.livementor.com"],"path":["v1","coachings",":id","complete"],"variable":[{"key":"id","value":"33699","description":"Identifier of the coaching to complete"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Date","value":"Wed, 06 Jan 2021 15:57:44 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Etag","value":"W/\"460cdd5549d599e82f3bc5374cc895f0\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"46e16925-4c17-435d-a5dc-fe238d8dd81d"},{"key":"X-Runtime","value":"0.227628"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 33699,\n \"student_id\": 32815,\n \"mentor_id\": 99458,\n \"start_date\": \"2021-01-02T12:00:00.000Z\",\n \"end_date\": \"2021-01-02T12:30:00.000Z\",\n \"status\": \"completed\",\n \"timekit_id\": \"6732f09b-5e9a-411c-a272-6cfa77e1d1b0\",\n \"zoom_id\": null,\n \"replay_url\": null,\n \"created_at\": \"2021-01-06T15:52:58.477Z\",\n \"updated_at\": \"2021-01-06T15:57:45.302Z\",\n \"stop_asking_feedback_at\": null,\n \"zoom_start_url\": null,\n \"context\": \"regular\",\n \"training_course_id\": 1,\n \"confirmed_no_show_at\": null\n }\n}"}],"_postman_id":"9f2fbf44-9703-4649-945c-ecd122488c35"},{"name":"Confirm a coaching as no show","id":"56175151-f264-42fc-8d2e-2cac6ed9061b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.livementor.com/v1/coachings/:id/confirm_no_show","description":"

The platform automatically detects and flags no_show coachings.

The mentor has then the availability to confirm or infirm the coaching as now show (false positive).

This endpoint is to be used to confirm a no_show coaching set by the system.

It sets the confirmed_no_show_at attribute of a coaching.

Identifier of the coaching to confirm as no show

\n","type":"text/plain"},"type":"any","value":"29223","key":"id"}]}},"response":[{"id":"9aae4b54-af48-4cf3-b79d-1d8e66ecbcac","name":"Confirm a coaching as no show","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.livementor.com/v1/coachings/:id/confirm_no_show","host":["https://api.livementor.com"],"path":["v1","coachings",":id","confirm_no_show"],"variable":[{"key":"id","value":"29223"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"075d659c869f8fd2ee0df010fe8e5e95\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"62416aad-59a2-4035-b447-2c02840e4a64"},{"key":"X-Runtime","value":"0.482892"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": true\n}"}],"_postman_id":"56175151-f264-42fc-8d2e-2cac6ed9061b"}],"id":"e030afb5-8f3f-41ed-9e5b-bbd50233df9a","description":"

Coachings are key components of LiveMentor experience.

A coaching is an online live meeting happening between a student and a mentor.

\n
\n\n

The following external tools are used to manage coachings:

Timekit: used to manage the booking of a coaching (calendar events, availability checking, ...)
Zoom: this is where the coaching is happening. Both mentor and student connect to a Zoom meeting to be able to communicate

\nA coaching is happening in a context, which can be:

kickoff: it is the first coaching between a mentor and a student
regular: a regular coaching between a student and his/her mentor
certification_exam: a coaching during which a mentor will grade a student for a given certification

\nA coaching also has a lifecycle and can go through the following states:

confirmed: the coaching has been booked and will happen in a foreseeable future
completed: the coaching happened and is now over
cancelled: the coaching was cancelled by LiveMentor
rescheduled: the coaching has been rescheduled by LiveMentor. Another coaching instance has been created
no_show: the student didn't come to the coaching
cancelled_by_customer[DEPRECATED]: the coaching was cancelled by the student
rescheduled_by_customer[DEPRECATED]: the coaching has been rescheduled by the student. Another coaching instance has been created

\n $\"State$

\n","event":[{"listen":"prerequest","script":{"id":"cc687fec-b94b-4d0f-ae61-94d6e717b697","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0d51404e-7f8d-48f2-a249-f007aed24e35","type":"text/javascript","exec":[""]}}],"_postman_id":"e030afb5-8f3f-41ed-9e5b-bbd50233df9a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Community Profile","item":[{"name":"Update profile","id":"aef319ba-43ed-400e-a37f-fd55e2469a48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"community_profile\": {\n \"about\": \"About my project and me bla coucou\",\n \"relationships_wanted\": [\"peer\"],\n \"display_settings\": {\n \"about\": true,\n \"objective\": true\n },\n \"objective\": \"Save the world\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.livementor.com/v1/community/profiles/:id","urlObject":{"path":["v1","community","profiles",":id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

the user id of the profile to update

\n","type":"text/plain"},"type":"any","value":"317156","key":"id"}]}},"response":[],"_postman_id":"aef319ba-43ed-400e-a37f-fd55e2469a48"},{"name":"Update avatar","id":"fcaccc94-407d-4006-9cbc-7b926ebc0829","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"avatar","type":"file","src":"/Users/cybilbourely/Desktop/Screenshot 2023-09-26 at 15.53.27.png"}]},"url":"https://api.livementor.com/v1/community/profiles/:id/avatar","urlObject":{"path":["v1","community","profiles",":id","avatar"],"host":["https://api.livementor.com"],"query":[],"variable":[{"type":"any","value":"16377","key":"id"}]}},"response":[],"_postman_id":"fcaccc94-407d-4006-9cbc-7b926ebc0829"}],"id":"93441933-a5d9-4538-8486-6c1fdd4d9ff0","_postman_id":"93441933-a5d9-4538-8486-6c1fdd4d9ff0","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Contract","item":[{"name":"Retrieve contracts","id":"a4e3ab77-02c7-487e-ba17-d982c76964bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/contracts","description":"

A list of the authenticated user contracts (CIF), sorted by date descending.

Contracts are documents that have been signed by the authenticated user.

A contract contains the following informations:

an order_number (string), the order it belongs to,
an created_at date (datetime),
a download_url to retrieve the contract as a PDF file.

\n","_postman_id":"13d21abe-66d1-46e9-8dc3-3f7ea43a55fc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Document","item":[{"name":"Retrieve documents","id":"7be10583-37e3-4afe-9033-f0be15d736d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/documents?kind=legal_certification&training_course=1234&status=signed","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","documents"],"host":["https://api.livementor.com"],"query":[{"key":"kind","value":"legal_certification"},{"key":"training_course","value":"1234"},{"key":"status","value":"signed"}],"variable":[]}},"response":[{"id":"e4765e86-6586-4eb0-a602-2889d96fcaf8","name":"Index","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/documents?kind=legal_certification&training_course=1234","host":["https://api.livementor.com"],"path":["v1","documents"],"query":[{"key":"kind","value":"legal_certification","description":"available values are: 'legal_certification'"},{"key":"training_course","value":"1234","description":"Identifier of a training course to get document for "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"76d832466f36ba8c85d84f16c9da0829\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"60cb2f19-cf65-4bae-8995-c178c1a8df4d"},{"key":"X-Runtime","value":"0.041809"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1234,\n \"kind\": \"legal_certification\",\n \"file_url\": \"https://hellomentor.s3.amazonaws.com/training_documents/legal_certification/Attestation de formation et d'assiduité XXXXXXXX.pdf\",\n \"hellosign_signature_id\": null,\n \"limit_date\": \"2020-11-06\",\n \"status\": \"waiting\",\n \"sign_url\": \"https://www.livementor.de/app/attestation-formation/signature\"\n }\n ],\n \"total_items\": 1,\n \"pagination\": {\n \"current_page\": \"/v1/documents?kind=legal_certification&page=1&training_course=1234\",\n \"first_page\": \"/v1/documents?kind=legal_certification&page=1&training_course=1234\",\n \"last_page\": \"/v1/documents?kind=legal_certification&page=1&training_course=1234\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"7be10583-37e3-4afe-9033-f0be15d736d7"},{"name":"[Deprecated] To be signed","id":"43123890-57da-4db4-83da-1da2c8d90f9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.livementor.com/v1/documents/to_be_signed?user_id=123456","description":"

This endpoint is deprecated and will soon be removed and replaced by a better alternative.

For legal_certifications : retrieve administratively ended training courses

For webinar agreements : retrieve webinars which start in 30 minutes (or less) and non-passed ones

For absence proof : as soon as an absence proof is generated, it has to be signed

\n","urlObject":{"path":["v1","documents","to_be_signed"],"host":["https://api.livementor.com"],"query":[{"key":"user_id","value":"123456"}],"variable":[]}},"response":[{"id":"9297d7fc-8839-4290-acb0-378ffe6e0b03","name":"For current user","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/documents/to_be_signed"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Date","value":"Thu, 22 Jul 2021 12:04:14 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Etag","value":"W/\"5d3c6a58853beebdf4d3342c6b2a9048\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"90c3217f-390f-4d8c-8202-c015ed999994"},{"key":"X-Runtime","value":"0.079021"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n 12345\n ]\n}"},{"id":"2a78fcba-f9f4-4a34-9ee1-1abb339f21d0","name":"For a student (asked by mentor)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/documents/to_be_signed?user_id=123456","host":["https://api.livementor.com"],"path":["v1","documents","to_be_signed"],"query":[{"key":"user_id","value":"123456"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Date","value":"Thu, 22 Jul 2021 12:09:15 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Etag","value":"W/\"b33f676089f844039bcd2b26632eba5c\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"6a4a833d-f7f3-45a5-92a4-75628681f5de"},{"key":"X-Runtime","value":"0.101972"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n 1234,\n 6789,\n 12345\n ]\n}"}],"_postman_id":"43123890-57da-4db4-83da-1da2c8d90f9f"},{"name":"Retrieve a document","id":"a23365ab-8bd9-416c-bac7-ae24adfa6657","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.livementor.com/v1/documents/:id","urlObject":{"path":["v1","documents",":id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"type":"any","value":"1","key":"id"}]}},"response":[],"_postman_id":"a23365ab-8bd9-416c-bac7-ae24adfa6657"}],"id":"993eefd1-e5fc-44fc-a8e1-731adb81b7f9","description":"

As an official training organisation, there are several legal bindings for every training course. Some of them must be signed by students.

All documents are PDF files.
When required, they are electronically signed with HelloSign.
Documents are stored on AWS S3

Here is the list of available documents:

absence_proof: (\"Justificatif d'absence\") a document to be signed by a student to justify an absence to a oral examination coaching
legal_certification: (\"Attestation de présence\") a document to be signed by the student at the end of a training course
completion_certificate: (\"Certificat de réalisation\") a document provided by LiveMentor to every student at the end of the training course
training_diploma: (\"Parchemin de certification\") a document provided by LiveMentor to every student who succeed their certification. Must be signed for RS certifications.

A document has a status:

waiting: the document must be signed by the student
signed: the document has been signed by the student or does not require any signature. It is in its final state

\n","event":[{"listen":"prerequest","script":{"id":"aa097f40-ee77-4c62-81aa-ce2001446426","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d9ac0078-e630-4ee7-8da3-f730e1010b56","type":"text/javascript","exec":[""]}}],"_postman_id":"993eefd1-e5fc-44fc-a8e1-731adb81b7f9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Enrollment","item":[{"name":"Retrieve enrollments","id":"e8dd5563-ce91-47c6-bc5f-06f65b82c052","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/enrollments?enrollables=&enrollable_type=webinar","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","enrollments"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

(optional) a list of enrollable ids used as a filter

\n","type":"text/plain"},"key":"enrollables","value":""},{"description":{"content":"

(optional) an enrollable type used as a filter, e.g: \"webinar\"

\n","type":"text/plain"},"key":"enrollable_type","value":"webinar"}],"variable":[]}},"response":[{"id":"83191774-1ce4-44b7-b1c9-17b215cc140a","name":"Index","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/enrollments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 19424,\n \"student_id\": 299095,\n \"active\": false,\n \"created_at\": \"2021-01-28T10:01:35.809Z\",\n \"attended_at\": null,\n \"enrollable_id\": 988,\n \"enrollable_type\": \"webinar\"\n },\n {\n \"id\": 19398,\n \"student_id\": 299095,\n \"active\": true,\n \"created_at\": \"2021-01-27T13:00:49.767Z\",\n \"attended_at\": \"2021-01-27T13:01:17.292Z\",\n \"enrollable_id\": 980,\n \"enrollable_type\": \"webinar\"\n }\n ],\n \"total_items\": 2,\n \"pagination\": {\n \"current_page\": \"/v1/enrollments?page=1\",\n \"first_page\": \"/v1/enrollments?page=1\",\n \"last_page\": \"/v1/enrollments?page=1\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"e8dd5563-ce91-47c6-bc5f-06f65b82c052"},{"name":"Create an enrollment","id":"2a7ffcc5-467d-4650-a168-0a633842783c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"enrollable_id","value":"5","description":"

the identifier of the enrollable

\n","type":"text"},{"key":"enrollable_type","value":"webinar","description":"

the type of the enrollable

\n","type":"text"}]},"url":"https://api.livementor.com/v1/enrollments","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","enrollments"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"126e3e0c-1815-488e-b5df-b6736b7626a1","name":"Create","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"enrollable_id\": 988,\n \"enrollable_type\": \"webinar\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.livementor.com/v1/enrollments"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 19426,\n \"student_id\": 299095,\n \"enrollable_id\": 988,\n \"enrollable_type\": \"Webinar\",\n \"created_at\": \"2021-02-02T13:53:23.805Z\",\n \"updated_at\": \"2021-02-02T13:53:23.805Z\",\n \"active\": true,\n \"attended_at\": null,\n \"stop_asking_feedback_at\": null\n }\n}"}],"_postman_id":"2a7ffcc5-467d-4650-a168-0a633842783c"},{"name":"Delete an enrollment","id":"c137836f-90bc-468d-8ab8-d338769a65a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.livementor.com/v1/enrollments/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","enrollments",":id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

the identifier of the enrollment to delete

\n","type":"text/plain"},"type":"any","value":"1234","key":"id"}]}},"response":[{"id":"11e0fcb4-b64b-45e6-bce5-d3a4560251c8","name":"Delete","originalRequest":{"method":"DELETE","header":[],"url":"https://api.livementor.com/v1/enrollments/19426"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"active\": false,\n \"id\": 19426,\n \"student_id\": 299095,\n \"enrollable_id\": 988,\n \"enrollable_type\": \"Webinar\",\n \"created_at\": \"2021-02-02T13:53:23.805Z\",\n \"updated_at\": \"2021-02-02T13:54:15.487Z\",\n \"attended_at\": null,\n \"stop_asking_feedback_at\": null\n }\n}"}],"_postman_id":"c137836f-90bc-468d-8ab8-d338769a65a8"},{"name":"Join an enrollment","id":"c73bb6a0-9ce2-4ab9-a6af-9e02df970b4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.livementor.com/v1/enrollments/:id/join","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","enrollments",":id","join"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

the identifier of the enrollment to join

\n","type":"text/plain"},"type":"any","value":"1234","key":"id"}]}},"response":[{"id":"7dba5660-54ee-4934-b8c9-550ad126fbee","name":"Join","originalRequest":{"method":"PUT","header":[],"url":"https://api.livementor.com/v1/enrollments/1234/join"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"join_url\": \"https://example.com/join/abcd\"\n }\n}"}],"_postman_id":"c73bb6a0-9ce2-4ab9-a6af-9e02df970b4b"}],"id":"f675d97c-6f15-4f6d-aa06-2020b26a8fd5","description":"

Enrollments are registrations to follow a webinar (or another enrollable object) live.

An enrollment contains the following informations:

id,
active,
student_id,
enrollable_id,
enrollable_type,
attended_at.

\n","_postman_id":"f675d97c-6f15-4f6d-aa06-2020b26a8fd5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Evaluator","item":[{"name":"Retrieve coachings","id":"56237f78-4ec4-4b07-b21e-79230a429523","request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/evaluator/coachings?missing_actions=false&start_date=2024-01-01&end_date=2024-12-31","description":"

Retrieve list of coachings for evaluator. Can be filtered by date range and missing actions.

Filter coachings that require actions from evaluator

\n","type":"text/plain"},"key":"missing_actions","value":"false"},{"description":{"content":"

Start date filter (YYYY-MM-DD)

\n","type":"text/plain"},"key":"start_date","value":"2024-01-01"},{"description":{"content":"

End date filter (YYYY-MM-DD)

\n","type":"text/plain"},"key":"end_date","value":"2024-12-31"}],"variable":[]}},"response":[{"id":"b634b52d-1c48-446d-b093-3cc6abfa8bc3","name":"Successful response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/evaluator/coachings?missing_actions=false&start_date=2024-01-01&end_date=2024-12-31","host":["https://api.livementor.com"],"path":["v1","evaluator","coachings"],"query":[{"key":"missing_actions","value":"false"},{"key":"start_date","value":"2024-01-01"},{"key":"end_date","value":"2024-12-31"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 123,\n \"date\": \"Monday 15 January 2024\",\n \"start_hour\": \"10:00 +0100\",\n \"end_hour\": \"11:00 +0100\",\n \"student\": {\n \"id\": 456,\n \"first_name\": \"Marie\",\n \"last_name\": \"Dupont\",\n \"picture\": \"https://hellomentor.s3-eu-west-1.amazonaws.com/users/avatars/marie-dupont.jpg\"\n },\n \"training_course\": {\n \"masterclass_title\": \"Marketing Digital\",\n \"count_total_exercises\": 5,\n \"count_completed_exercises\": 3\n }\n },\n {\n \"id\": 124,\n \"date\": \"Tuesday 16 January 2024\",\n \"start_hour\": \"14:00 +0100\",\n \"end_hour\": \"15:00 +0100\",\n \"student\": {\n \"id\": 457,\n \"first_name\": \"Pierre\",\n \"last_name\": \"Martin\",\n \"picture\": \"https://hellomentor.s3-eu-west-1.amazonaws.com/users/avatars/pierre-martin.jpg\"\n },\n \"training_course\": {\n \"masterclass_title\": null,\n \"count_total_exercises\": 2,\n \"count_completed_exercises\": 2\n }\n }\n ],\n \"total_items\": 2,\n \"pagination\": {\n \"current_page\": \"/v1/evaluator/coachings?page=1\",\n \"first_page\": \"/v1/evaluator/coachings?page=1\",\n \"last_page\": \"/v1/evaluator/coachings?page=1\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"},{"id":"cf3897e4-e914-4a02-8d7d-5354a8ea6392","name":"Response with missing actions","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/evaluator/coachings?missing_actions=true","host":["https://api.livementor.com"],"path":["v1","evaluator","coachings"],"query":[{"key":"missing_actions","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 123,\n \"date\": \"Monday 15 January 2024\",\n \"start_hour\": \"10:00 +0100\",\n \"end_hour\": \"11:00 +0100\",\n \"student\": {\n \"id\": 456,\n \"first_name\": \"Marie\",\n \"last_name\": \"Dupont\",\n \"picture\": \"https://hellomentor.s3-eu-west-1.amazonaws.com/users/avatars/marie-dupont.jpg\"\n },\n \"training_course\": {\n \"masterclass_title\": \"Marketing Digital\",\n \"count_total_exercises\": 5,\n \"count_completed_exercises\": 3\n },\n \"missing_actions\": {\n \"sign_attendance\": false,\n \"fill_typeform\": true,\n \"declare_no_show\": true\n }\n }\n ],\n \"total_items\": 1,\n \"pagination\": {\n \"current_page\": \"/v1/evaluator/coachings?page=1\",\n \"first_page\": \"/v1/evaluator/coachings?page=1\",\n \"last_page\": \"/v1/evaluator/coachings?page=1\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"56237f78-4ec4-4b07-b21e-79230a429523"},{"name":"Retrieve coaching details","id":"40f842f3-d53b-411d-83e4-f3022294b61f","request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/evaluator/coachings/:id","description":"

Retrieve details of a specific coaching including student information, certification data, and available actions (typeform, attendance signature, zoom links).

Coaching ID

\n","type":"text/plain"},"type":"any","value":"123","key":"id"}]}},"response":[{"id":"5efa74d7-6392-4bad-8fdf-9c2ac983ce59","name":"Successful response","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/evaluator/coachings/123"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"student\": {\n \"id\": 456,\n \"first_name\": \"Marie\",\n \"last_name\": \"Dupont\",\n \"picture\": \"https://hellomentor.s3-eu-west-1.amazonaws.com/users/avatars/marie-dupont.jpg\",\n \"goal\": \"Créer ma propre agence de marketing\",\n \"project_stage\": \"idea\",\n \"description\": \"Je souhaite créer une agence spécialisée en marketing digital\",\n \"motivations_goals\": \"Devenir indépendante et aider les PME\",\n \"current_situation_review\": \"Employée en marketing depuis 3 ans\",\n \"sector_interest\": \"Marketing digital\",\n \"career_goal\": \"Entrepreneur\"\n },\n \"coaching\": {\n \"id\": 123,\n \"date\": \"Monday 15 January 2024\",\n \"start_hour\": \"10:00 +0100\",\n \"end_hour\": \"11:00 +0100\",\n \"status\": \"completed\",\n \"attendance_doc_url\": \"https://sign.example.com/document/abc123\",\n \"zoom_start_url\": null,\n \"replay_url\": \"https://replay.zoom.com/xyz\"\n },\n \"certification\": {\n \"masterclass_title\": \"Marketing Digital\",\n \"course_plan\": \"Plan de cours Marketing\",\n \"typeform_url\": \"https://hellomentor-staging.herokuapp.com/app/quizzes/evaluate?masterclass_id=101&kind=student_evaluation&student_id=456&certification_id=321\",\n \"guide_url\": \"https://hellomentor-staging.herokuapp.com/app/certification/guide?downloaded_from=chat_sidebar&kind=evaluator&certification_id=321\",\n \"assessments\": [\n {\n \"id\": 111,\n \"skill\": {\n \"id\": 222,\n \"exercise\": {\n \"id\": 333,\n \"title\": \"Plan Marketing\",\n \"mandatory\": true,\n \"files\": [\n {\n \"id\": 444,\n \"name\": \"plan-marketing.pdf\",\n \"url\": \"/rails/active_storage/blobs/xyz/plan-marketing.pdf\"\n }\n ]\n }\n }\n },\n {\n \"id\": 112,\n \"skill\": {\n \"id\": 223\n }\n }\n ]\n }\n }\n}"}],"_postman_id":"40f842f3-d53b-411d-83e4-f3022294b61f"},{"name":"Retrieve invoicing periods","id":"96af4169-b26e-44d4-8abc-d0ae730d11a6","request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/evaluator/invoicing","description":"

Retrieve invoicing summary grouped by month for coachings completed more than 1 month ago. Shows count and amounts for candidates and students.

Retrieve detailed list of coachings for a specific month for invoicing purposes. Only shows completed coachings and no-shows caused by students.

Month in format MM-YYYY

\n","type":"text/plain"},"key":"month","value":"01-2024"}],"variable":[]}},"response":[{"id":"dbe03091-c66e-4c6d-9aa5-1f3fd73be6c6","name":"Successful response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/evaluator/invoicing/coachings?month=12-2023","host":["https://api.livementor.com"],"path":["v1","evaluator","invoicing","coachings"],"query":[{"key":"month","value":"12-2023"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 123,\n \"date\": \"2023-12-15T10:00:00+01:00\",\n \"full_name\": \"Marie Dupont\",\n \"internal_candidate\": false\n },\n {\n \"id\": 124,\n \"date\": \"2023-12-20T14:00:00+01:00\",\n \"full_name\": \"Pierre Martin\",\n \"internal_candidate\": true\n }\n ],\n \"total_items\": 2,\n \"pagination\": {\n \"current_page\": \"/v1/evaluator/invoicing/coachings?page=1\",\n \"first_page\": \"/v1/evaluator/invoicing/coachings?page=1\",\n \"last_page\": \"/v1/evaluator/invoicing/coachings?page=1\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"},{"id":"b0f62995-24d0-41cc-949d-411a14f92f65","name":"Missing month parameter","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/evaluator/invoicing/coachings"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"key\": \"missing_parameters\",\n \"message\": \"Missing parameter: month\"\n }\n}"}],"_postman_id":"7fd92e10-30cc-4861-b3fb-c47935853e85"}],"id":"4b3a0255-6d9d-4bfd-aeda-8d2b2f84dc43","description":"

Endpoints for evaluators to manage their coachings and invoicing. Evaluators can view their coaching sessions, access student evaluation tools, and manage monthly invoicing data.

\n","_postman_id":"4b3a0255-6d9d-4bfd-aeda-8d2b2f84dc43","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Feedback","item":[{"name":"Retrieve feedbacks","id":"3142e45a-4d36-499a-96d6-d5742c826b46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/feedbacks?feedbackables=&feedbackable_type=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","feedbacks"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

(optional) a list of feedbackable ids used as a filter

\n","type":"text/plain"},"key":"feedbackables","value":""},{"description":{"content":"

(optional) a feedbackable type used as a filter, e.g: \"course\"

\n","type":"text/plain"},"key":"feedbackable_type","value":""}],"variable":[]}},"response":[{"id":"d1a35223-d2f9-48c4-a937-2ceb5c399f6e","name":"Index","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/feedbacks"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 4,\n \"user_id\": 5,\n \"positive\": false,\n \"reason\": \"J'aurais aimé avoir plus d'exemples.\",\n \"created_at\": \"2021-01-18T10:13:47.309Z\",\n \"feedbackable_id\": 1401,\n \"feedbackable_type\": \"course\"\n },\n {\n \"id\": 5,\n \"user_id\": 5,\n \"positive\": true,\n \"reason\": null,\n \"created_at\": \"2021-01-18T10:13:07.666Z\",\n \"feedbackable_id\": 1400,\n \"feedbackable_type\": \"course\"\n }\n ],\n \"total_items\": 2,\n \"pagination\": {\n \"current_page\": \"/v1/feedbacks?page=1\",\n \"first_page\": \"/v1/feedbacks?page=1\",\n \"last_page\": \"/v1/feedbacks?page=1\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"3142e45a-4d36-499a-96d6-d5742c826b46"},{"name":"Create a feedback","id":"ae81fe8b-88ab-4a8b-b81b-ced718814408","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"feedbackable_id","value":"5","description":"

the identifier of the feedbackable

\n","type":"text"},{"key":"feedbackable_type","value":"course","description":"

the type of the feedbackable

\n","type":"text"},{"key":"positive","value":"true","description":"

the feedback as a boolean

\n","type":"text"},{"key":"reason","value":"a text","description":"

the reason if the feedback is negative

\n","type":"text"}]},"url":"https://api.livementor.com/v1/feedbacks","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","feedbacks"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae81fe8b-88ab-4a8b-b81b-ced718814408"}],"id":"15d729f2-fc5b-4f2c-b517-8e862b3574b2","description":"

Feedbacks can be sent by a user to give a positive or negative assessment regarding an instance they encountered.

A feedback contains the following informations:

a feedbackable_id and a feedbackable_type (e.g: \"course\", \"webinar\"), to identify the corresponding instance,
a user_id,
the boolean attribute positive, to determine if the feedback is positive or negative,
the reason (optional), used if the feedback is negative.

\n","_postman_id":"15d729f2-fc5b-4f2c-b517-8e862b3574b2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Form","item":[{"name":"Retrieve form current section","id":"06420812-1cd9-491c-ae9e-596ce2f0bff3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/form/:key/section","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","form",":key","section"],"host":["https://api.livementor.com"],"query":[],"variable":[{"type":"any","value":"impact","key":"key"}]}},"response":[{"id":"10678466-b397-48ae-b357-1b42540a968f","name":"Retrieve form current section (contact_information)","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/form/impact/section"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"c07e8be66255638e6e8492d5daf24311\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"13393e9f-5231-4aa5-bf96-26125f233294"},{"key":"X-Runtime","value":"0.710600"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"ref\": \"contact_information\",\n \"subtitle\": \"Vos coordonnées\",\n \"title\": \"Profil\",\n \"questions\": [\n {\n \"ref\": \"gender\",\n \"title\": \"Genre\",\n \"type\": \"radio_button\",\n \"answers\": {\n \"male\": \"Homme\",\n \"female\": \"Femme\",\n \"non_binary\": \"Non binaire\"\n },\n \"user_answer\": \"male\"\n },\n {\n \"block\": [\n {\n \"ref\": \"given_name\",\n \"title\": \"Prénom\",\n \"type\": \"text_field\",\n \"user_answer\": \"John\"\n },\n {\n \"ref\": \"family_name\",\n \"title\": \"Nom\",\n \"type\": \"text_field\",\n \"user_answer\": \"Doe\"\n }\n ]\n },\n {\n \"ref\": \"birthday\",\n \"title\": \"Date de naissance\",\n \"type\": \"date\",\n \"user_answer\": \"1990-01-01T00:00:00.000Z\"\n },\n {\n \"ref\": \"postal_address\",\n \"title\": \"Adresse\",\n \"type\": \"address_field\",\n \"user_answer\": \"42 rue du guide intergalactique, 75000 Paris, FR\"\n },\n {\n \"ref\": \"email\",\n \"title\": \"Adresse email\",\n \"type\": \"email_field\",\n \"user_answer\": \"john.doe@gmail.com\"\n },\n {\n \"ref\": \"handicap\",\n \"title\": \"Êtes-vous en situation de handicap ?\",\n \"type\": \"binary_choice\",\n \"answers\": {\n \"true\": \"Oui\",\n \"false\": \"Non\"\n },\n \"user_answer\": null\n },\n {\n \"ref\": \"study_level\",\n \"title\": \"Niveau d'étude\",\n \"type\": \"radio_button\",\n \"answers\": {\n \"no_diploma\": \"Pas de diplôme / Autodidacte\",\n \"cap_bep\": \"CAP / BEP\",\n \"bac_bac_pro\": \"Bac / Bac Pro\",\n \"bac_2\": \"Bac +2\",\n \"bac_3\": \"Bac +3\",\n \"bac_4\": \"Bac +4\",\n \"bac_5\": \"Bac +5\",\n \"bac_6_more\": \"Au delà de Bac +5\"\n },\n \"user_answer\": \"bac_5\"\n }\n ]\n }\n}"},{"id":"9fa6f962-d213-4a82-aea8-095630730ae8","name":"Retrieve form current section (pole_emploi)","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/form/impact/section"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"18e84963e6960767c0106f8de8ba47a0\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"9e3fac3b-45bc-4cee-b940-3f27684d51e2"},{"key":"X-Runtime","value":"0.383727"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"ref\": \"pole_emploi\",\n \"subtitle\": \"Votre situation\",\n \"title\": \"Situation actuelle\",\n \"questions\": [\n {\n \"ref\": \"pole_emploi\",\n \"title\": \"Êtes-vous rattaché à Pôle Emploi ?\",\n \"type\": \"binary_choice\",\n \"answers\": {\n \"true\": \"Oui\",\n \"false\": \"Non\"\n },\n \"user_answer\": null\n }\n ]\n }\n}"}],"_postman_id":"06420812-1cd9-491c-ae9e-596ce2f0bff3"},{"name":"Updates user form info","id":"4b7a483a-963c-4690-a6c6-ac4f24fb79b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"data[handicap]","value":"false","description":"

the handicap situation of the user card

\n","type":"text"}]},"url":"https://api.livementor.com/v1/form/impact","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","form","impact"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"a985cbeb-f118-49a7-84f6-1861427b2068","name":"Updates user card handicap for impact form","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"data[handicap]","value":"false","description":"the handicap situation of the user card","type":"text"}],"options":{"raw":{"language":"javascript"}}},"url":"https://api.livementor.com/v1/form/impact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"18e84963e6960767c0106f8de8ba47a0\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"bb2e0b6f-e8b9-46d6-b146-7d9d20261bfd"},{"key":"X-Runtime","value":"7.402114"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"ref\": \"pole_emploi\",\n \"subtitle\": \"Votre situation\",\n \"title\": \"Situation actuelle\",\n \"questions\": [\n {\n \"ref\": \"pole_emploi\",\n \"title\": \"Êtes-vous rattaché à Pôle Emploi ?\",\n \"type\": \"binary_choice\",\n \"answers\": {\n \"true\": \"Oui\",\n \"false\": \"Non\"\n },\n \"user_answer\": null\n }\n ]\n }\n}"}],"_postman_id":"4b7a483a-963c-4690-a6c6-ac4f24fb79b2"}],"id":"629d6b3b-13e3-44a4-a237-7171758d5348","description":"

Form represent a form template with ordered sections and questions.

\n","event":[{"listen":"prerequest","script":{"id":"d0c2438b-66f6-4c76-80a4-ee0e25b43ede","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5ecabc73-d417-4b43-a148-3c2787c42db1","type":"text/javascript","exec":[""]}}],"_postman_id":"629d6b3b-13e3-44a4-a237-7171758d5348","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Full Onboarding","item":[{"name":"Update onboarding data","id":"fe40a950-c73c-4ca4-b6ba-167059fc5c19","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"user__given_name\": \"Marie\",\n \"user__family_name\": \"Dupont\",\n \"user__gender\": \"female\",\n \"user__birthday\": \"1990-05-15\",\n \"user__pro_situation\": \"employee\",\n \"user__training_goal\": \"Créer ma propre entreprise\",\n \"user_address__line\": \"123 rue de la République\",\n \"user_address__postal_code\": \"75011\",\n \"user_address__city\": \"Paris\",\n \"user_address__country\": \"France\",\n \"user_project__description\": \"Je souhaite créer une agence de marketing digital spécialisée dans l'accompagnement des PME\",\n \"user_project__stage\": \"idea\",\n \"user_project__motivations_goals\": \"Devenir indépendante et aider les entreprises à se développer\",\n \"user_project__budget\": \"10000\",\n \"community_profile__community_access\": true,\n \"community_profile__about\": \"Passionnée de marketing digital avec 5 ans d'expérience\",\n \"user_availabilities__global_availabilities\": [\n {\n \"day_of_week\": \"monday\",\n \"start_time\": \"09:00\",\n \"end_time\": \"12:00\"\n },\n {\n \"day_of_week\": \"wednesday\",\n \"start_time\": \"14:00\",\n \"end_time\": \"17:00\"\n }\n ]\n }\n}"},"url":"https://api.livementor.com/v1/full_onboarding?training_course_id=123","description":"

Update user onboarding data including personal information, address, project details, and availabilities. Data keys follow the pattern 'resource__field_name'.

Training course ID

\n","type":"text/plain"},"key":"training_course_id","value":"123"}],"variable":[]}},"response":[{"id":"a3e8fa85-88c8-4f02-a399-0ecda9fd62c8","name":"Successful update","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"user__given_name\": \"Marie\",\n \"user__family_name\": \"Dupont\",\n \"user_address__line\": \"123 rue de la République\",\n \"user_address__postal_code\": \"75011\",\n \"user_address__city\": \"Paris\",\n \"user_address__country\": \"France\",\n \"user_project__description\": \"Ma nouvelle idée de projet\"\n }\n}"},"url":{"raw":"https://api.livementor.com/v1/full_onboarding?training_course_id=123","host":["https://api.livementor.com"],"path":["v1","full_onboarding"],"query":[{"key":"training_course_id","value":"123"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"success\": true\n }\n}"},{"id":"a2ddc59c-4276-4784-b0bf-1718837336e1","name":"Final validation","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"final_validation\": true\n }\n}"},"url":{"raw":"https://api.livementor.com/v1/full_onboarding?training_course_id=123","host":["https://api.livementor.com"],"path":["v1","full_onboarding"],"query":[{"key":"training_course_id","value":"123"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"success\": true\n }\n}"},{"id":"31eb08a3-72b2-47f4-a450-e989f3ddca58","name":"Missing training course ID","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"user__given_name\": \"Marie\"\n }\n}"},"url":"https://api.livementor.com/v1/full_onboarding"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"message\": \"training_course_id is missing\"\n }\n}"}],"_postman_id":"fe40a950-c73c-4ca4-b6ba-167059fc5c19"}],"id":"3b416435-7ee7-4d20-aa3c-3f32957b0d8d","description":"

Full onboarding endpoints for training courses with coaching. Allows updating user personal information, address, project details, community profile, and availabilities in a single request.

\n","_postman_id":"3b416435-7ee7-4d20-aa3c-3f32957b0d8d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Invoice","item":[{"name":"Retrieve invoices","id":"e201945d-bc97-4b04-b078-2b68e717b2be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/invoices","description":"

A list of the authenticated user invoices, sorted by date descending and ignoring invoices void or paid by a third-party (funding agency).

Invoices are statements of sums due or paid by the authenticated user.

An invoice contains the following informations:

an order_number (string),
an ordered_at date (datetime),
a price in euros (float),
a download_url that should be accessed with the appropriate jwt token for authentication.

\n","_postman_id":"5b1ded24-16c6-4d4b-998d-a76aba00894e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Lesson","item":[{"name":"Retrieve lessons","id":"55d8e056-fb54-4467-8ef4-6bc58d519ec5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/lessons?masterclasses=&modules=&lessons=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","lessons"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

(optional) a list of masterclass ids used as a filter

\n","type":"text/plain"},"key":"masterclasses","value":""},{"description":{"content":"

(optional) a list of module ids used as a filter

\n","type":"text/plain"},"key":"modules","value":""},{"description":{"content":"

(optional) a list of lesson ids used as a filter

\n","type":"text/plain"},"key":"lessons","value":""}],"variable":[]}},"response":[{"id":"4ef8e956-dc58-4bcd-aefd-8d31c1862421","name":"Index","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/lessons"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":" {\n \"data\": [\n {\n \"id\": 665,\n \"title\": \"Bienvenue dans la formation Vasco de Gama !\"\n },\n {\n \"id\": 708,\n \"title\": \"Les questions à se poser avant de lancer son site e-commerce\"\n },\n {\n \"id\": 709,\n \"title\": \"Comment se différencier pour percer ?\"\n }\n }\n}"}],"_postman_id":"55d8e056-fb54-4467-8ef4-6bc58d519ec5"},{"name":"Retrieve a lesson","id":"aeb45815-8646-43aa-9710-9f2a2b2fd477","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/lessons/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","lessons",":id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

the identifier of the lesson

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"48bf293f-df3c-486e-941c-311053ffc742","name":"Show","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/lessons/665"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 665,\n \"title\": \"Bienvenue dans la formation Vasco de Gama !\",\n \"description\": \"

LiveMentor veut accompagner les passionnés, ceux qui confectionnent, créent, achètent, s'approvisionnent en produits unique, originaux, exceptionnels.

Chez LiveMentor, on refuse de laisser la plupart des e-commerçant ferment boutique, se retrouvent avec une trésorerie en difficulté ou se fassent avoir par des technologies peu efficaces.

C'est pour cela que nous avons lancé la formation Vasco De Gama. Nous avons créé cette formation en écoutant vos besoins et vos demandes.

\",\n \"video_url\": \"https://vimeo.com/\",\n \"document_url\": null,\n \"discourse_topic_id\": 842\n }\n}"}],"_postman_id":"aeb45815-8646-43aa-9710-9f2a2b2fd477"}],"id":"1d38af97-22ee-4c2f-a24b-97ccdbae37b9","description":"

Lessons are the main type of content of a masterclass. It's a video content generally joined by a pdf material.

A lesson contains the following informations:

a title,
a viewed_by_user flag if the current user has viewed the video at least once,
a previewable flag is the current user has completed the quiz at least once,
a description (show only),
the video_url (show only),
the document_url (show only),
the discourse_topic_id (show only).

\n","_postman_id":"1d38af97-22ee-4c2f-a24b-97ccdbae37b9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Lesson View","item":[{"name":"[DEPRECATED] Retrieve lesson views","id":"b89cf23e-6ac7-4522-87fb-fac84f9bcf6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/lesson_views?lessons=","description":"

This endpoint is deprecated. Use the viewed_by_user attribute in Lesson endpoints instead.

(optional) a list of lesson ids used as a filter

\n","type":"text/plain"},"key":"lessons","value":""}],"variable":[]}},"response":[{"id":"a5014961-df5c-45c0-bf07-111b96a80486","name":"Index","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/lesson_views?lessons=1317,708","host":["https://api.livementor.com"],"path":["v1","lesson_views"],"query":[{"key":"lessons","value":"1317,708","description":"(optional) a list of lesson ids used as a filter"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 288632,\n \"user_id\": 299095,\n \"lesson_id\": 1317\n },\n {\n \"id\": 288621,\n \"user_id\": 299095,\n \"lesson_id\": 708\n }\n ],\n \"total_items\": 2,\n \"pagination\": {\n \"current_page\": \"/v1/lesson_views?lessons=1317%2C708&page=1\",\n \"first_page\": \"/v1/lesson_views?lessons=1317%2C708&page=1\",\n \"last_page\": \"/v1/lesson_views?lessons=1317%2C708&page=1\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"b89cf23e-6ac7-4522-87fb-fac84f9bcf6d"},{"name":"Create a lesson view","id":"02497ca1-982e-472b-9320-6f438e7cc42e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"lesson_id","value":"4","description":"

the identifier of the lesson

\n","type":"text"}]},"url":"https://api.livementor.com/v1/lesson_views","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","lesson_views"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"02497ca1-982e-472b-9320-6f438e7cc42e"}],"id":"0f66db0c-c0c6-426a-b672-f0a1397dd6fd","description":"

Lesson views represent the fact that a user has viewed a lesson.

A lesson view contains the following informations:

a lesson_id,
a user_id.

\n","_postman_id":"0f66db0c-c0c6-426a-b672-f0a1397dd6fd","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Masterclass","item":[{"name":"Retrieve masterclasses","id":"63b640c1-e119-473c-a9bb-105754671e7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/masterclasses","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","masterclasses"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"84b1155c-df1d-421a-b4aa-d7cfa3c8a363","name":"Index","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/masterclasses"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 102,\n \"title\": \"Vasco de Gama\",\n \"picture_url\": null\n },\n {\n \"id\": 92,\n \"title\": \"Instagram\",\n \"picture_url\": null\n },\n {\n \"id\": 156,\n \"title\": \"Vendre & Convaincre\",\n \"picture_url\": null\n }\n ]\n}"}],"_postman_id":"63b640c1-e119-473c-a9bb-105754671e7a"},{"name":"Retrieve a masterclass","id":"1cb30362-6f71-424b-9dc3-e0f2529cb86f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/masterclasses/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","masterclasses",":id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

the identifier of the masterclass

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ed6f56ca-4d85-42a0-9b0c-2ed9798e2d82","name":"Show","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/masterclasses/102"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 102,\n \"title\": \"Vasco de Gama\",\n \"module_ids\": [\n [1, 615],\n [2, 621],\n [3, 622]\n ],\n \"picture_url\": null\n }\n}"}],"_postman_id":"1cb30362-6f71-424b-9dc3-e0f2529cb86f"}],"id":"1d19e917-d67f-4f10-b0cd-471e233ea9e0","description":"

Masterclasses are classes available to students on LiveMentor.

A masterclass contains an ordered list of modules, each of which contains an ordered list of lessons and bonuses.

Access is granted per masterclass, which means each student can only access masterclasses they subscribed to. Mentors can access all masterclasses.

\n","_postman_id":"1d19e917-d67f-4f10-b0cd-471e233ea9e0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Message Template","item":[{"name":"List message templates","id":"f07bec48-83b1-4628-a971-2ba84de3d69a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/message_templates","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"e482c7ff-b4b3-4cab-a347-ace39df10d5a","id":"e482c7ff-b4b3-4cab-a347-ace39df10d5a","name":"Message Template","type":"folder"}},"urlObject":{"path":["v1","message_templates"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"12198e74-0dac-4b14-9d15-ab833985a346","name":"List message templates for a mentor","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/message_templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"fba0a4fcf299c172f5291556dab22aaa\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"f0747c0a-ac16-4ded-b542-c0006902dee4"},{"key":"X-Runtime","value":"0.093166"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"user_id\": 12345,\n \"title\": \"A new template\",\n \"html_content\": \"

Here is some HTML

\"\n }\n ],\n \"total_items\": 1,\n \"pagination\": {\n \"current_page\": \"/v1/message_templates?page=1\",\n \"first_page\": \"/v1/message_templates?page=1\",\n \"last_page\": \"/v1/message_templates?page=1\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"f07bec48-83b1-4628-a971-2ba84de3d69a"},{"name":"Retrieve a message template","id":"72007b1a-1e2b-48e7-ba67-bae893a536f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/message_templates/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"e482c7ff-b4b3-4cab-a347-ace39df10d5a","id":"e482c7ff-b4b3-4cab-a347-ace39df10d5a","name":"Message Template","type":"folder"}},"urlObject":{"path":["v1","message_templates",":id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"type":"any","value":"1","key":"id"}]}},"response":[{"id":"efbc0156-f15e-4914-800c-0fd3c2e3e908","name":"Retrieve a message template","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/message_templates/:id","host":["https://api.livementor.com"],"path":["v1","message_templates",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"9d47c49165860850e40a5334136c1402\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"8f017197-94ae-460a-9ea8-edcab8c45148"},{"key":"X-Runtime","value":"0.031929"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1,\n \"user_id\": 12345,\n \"title\": \"A new template\",\n \"html_content\": \"

Here is some HTML

\"\n }\n}"}],"_postman_id":"72007b1a-1e2b-48e7-ba67-bae893a536f2"},{"name":"Update a message template","id":"d919e08d-d96b-4ac7-9377-bf80d14fc1ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.livementor.com/v1/message_templates/:id?title=A new template [EDITED]&html_content=

Here is some HTML

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"e482c7ff-b4b3-4cab-a347-ace39df10d5a","id":"e482c7ff-b4b3-4cab-a347-ace39df10d5a","name":"Message Template","type":"folder"}},"urlObject":{"path":["v1","message_templates",":id"],"host":["https://api.livementor.com"],"query":[{"key":"title","value":"A new template [EDITED]"},{"key":"html_content","value":"

Here is some HTML

"}],"variable":[{"type":"any","value":"1","key":"id"}]}},"response":[{"id":"e35a9834-3a96-4f04-8763-ec06aa260d43","name":"Update a message template","originalRequest":{"method":"PUT","header":[],"url":{"raw":"https://api.livementor.com/v1/message_templates/:id?title=A new template [EDITED]&html_content=

Here is some HTML

","host":["https://api.livementor.com"],"path":["v1","message_templates",":id"],"query":[{"key":"title","value":"A new template [EDITED]"},{"key":"html_content","value":"

Here is some HTML

"}],"variable":[{"key":"id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"8182b463135c9ad4bc4b80f35c97bdb6\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"22a2d082-f272-495d-8d59-06599f673753"},{"key":"X-Runtime","value":"0.074385"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1,\n \"user_id\": 12345,\n \"title\": \"A new template [EDITED]\",\n \"html_content\": \"

Here is some HTML

\"\n }\n}"}],"_postman_id":"d919e08d-d96b-4ac7-9377-bf80d14fc1ac"},{"name":"Create message template","id":"e31bea45-0716-4738-a5bf-6727c3a13fba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"title","value":"A new template","type":"text"},{"key":"html_content","value":"

Some HTML content ;)

","type":"text"}]},"url":"https://api.livementor.com/v1/message_templates","urlObject":{"path":["v1","message_templates"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"7e93b6e4-cb34-4da9-a020-ceed82a8c4f2","name":"Create message template","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"title","value":"A new template 2","type":"text"},{"key":"html_content","value":"

Some HTML content ;)

","type":"text"}]},"url":"https://api.livementor.com/v1/message_templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"b328b1611a0cf7cc326fbb8e35dfb2e7\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"9ab7217f-4e92-4f50-bdd2-d52661c2ec2f"},{"key":"X-Runtime","value":"0.160222"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1,\n \"user_id\": 123456,\n \"title\": \"A new template\",\n \"html_content\": \"

Some HTML content ;)

\"\n }\n}"}],"_postman_id":"e31bea45-0716-4738-a5bf-6727c3a13fba"}],"id":"e482c7ff-b4b3-4cab-a347-ace39df10d5a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"ff927384-a8a1-4930-90a8-53fdf174822f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dd10dda5-e66e-4ac7-890e-cfaf57cfb51e","type":"text/javascript","exec":[""]}}],"_postman_id":"e482c7ff-b4b3-4cab-a347-ace39df10d5a","description":""},{"name":"Milestone","item":[{"name":"Retrieve milestones","id":"613730fb-377e-4cae-9c28-896cd4dffc66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/milestones?masterclasses=&modules=&milestones=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","milestones"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

(optional) a list of masterclass ids used as a filter

\n","type":"text/plain"},"key":"masterclasses","value":""},{"description":{"content":"

(optional) a list of module ids used as a filter

\n","type":"text/plain"},"key":"modules","value":""},{"description":{"content":"

(optional) a list of milestone ids used as a filter

\n","type":"text/plain"},"key":"milestones","value":""}],"variable":[]}},"response":[{"id":"95ae4856-be1a-40ca-a68b-b17f2387571e","name":"Index","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/lessons"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":" {\n \"data\": [\n {\n \"id\": 665,\n \"title\": \"Premier jalon\",\n \"previewable\": false,\n \"completed_by_user\": true\n },\n {\n \"id\": 666,\n \"title\": \"Deuxième jalon\",\n \"previewable\": false,\n \"completed_by_user\": false\n },\n {\n \"id\": 667,\n \"title\": \"Troisième jalon\",\n \"previewable\": false,\n \"completed_by_user\": true\n }\n }\n}"}],"_postman_id":"613730fb-377e-4cae-9c28-896cd4dffc66"},{"name":"Retrieve a milestone","id":"f1ceab59-fa85-43ae-b44d-bc23de5503bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/milestones/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","milestones",":id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

the identifier of the lesson

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"36ed021c-ad86-4815-b153-55e15b2fe705","name":"Show","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/lessons/665"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 665,\n \"title\": \"Premier jalon\",\n \"description\": \"

Une description du premier jalon

\",\n \"typeform_url\": \"https://backend.livementor.com/app/quizzes/330/milestone?milestone_id=665\",\n \"completed_by_user\": true,\n\t\t\"previewable\": false,\n \"discourse_topic_id\": 842\n }\n}"}],"_postman_id":"f1ceab59-fa85-43ae-b44d-bc23de5503bc"}],"id":"425a6237-fe5a-4520-95a7-fbfb10ff25d3","description":"

Milestones are a type of content of a masterclass. It's a typeform quiz generally suggested to the student at the end of a module.

A milestone contains the following informations:

a title,
a completed_by_user flag if the current user has completed the quiz at least once,
a previewable flag is the content can be seen with the teasing access,
a description (show only),
the typeform_url (show only),
the discourse_topic_id (show only).

\n","_postman_id":"425a6237-fe5a-4520-95a7-fbfb10ff25d3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Module","item":[{"name":"Retrieve modules","id":"ac6d46b5-2034-4faa-85d5-1e45b580f4b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/modules?masterclasses=&modules=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","modules"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

(optional) a list of masterclass ids used as a filter

\n","type":"text/plain"},"key":"masterclasses","value":""},{"description":{"content":"

(optional) a list of module ids used as a filter

\n","type":"text/plain"},"key":"modules","value":""}],"variable":[]}},"response":[{"id":"01b99172-921f-4b9c-a1d3-b9cf1e982844","name":"Index","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/modules?masterclasses=92,102","host":["https://api.livementor.com"],"path":["v1","modules"],"query":[{"key":"masterclasses","value":"92,102","description":"(optional) a list of masterclass ids used as a filter"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 710,\n \"title\": \"Introduction\",\n \"position\": 1,\n \"masterclass_id\": 92,\n \"lesson_ids\": [\n [1,1317],\n [2,1318],\n [4,1319]\n ],\n \"milestone_ids\": [\n [3, 1320],\n [5, 1322]\n ]\n \"bonus_ids\": []\n },\n {\n \"id\": 711,\n \"title\": \"La plateforme : comprendre et s'orienter\",\n \"position\": 2,\n \"masterclass_id\": 92,\n \"lesson_ids\": [\n [1,1329],\n [2,1330]\n ],\n \"milestone_ids\": [\n [3, 1331],\n [4, 1332]\n ]\n \"bonus_ids\": []\n },\n {\n \"id\": 623,\n \"title\": \"Faire venir des clients sur sa boutique e-commerce\",\n \"position\": 4,\n \"masterclass_id\": 102,\n \"lesson_ids\": [\n [1,737],\n [2,716],\n [3,717],\n [4,718]\n ],\n \"milestone_ids: []\n \"bonus_ids\": []\n },\n {\n \"id\": 624,\n \"title\": \"J'ai réalisé mes premières ventes. Que faire ensuite ?\",\n \"position\": 5,\n \"masterclass_id\": 102,\n \"lesson_ids\": [\n [1,738],\n [2,720]\n ],\n \"milestone_ids\": [\n [3, 722]\n ]\n \"bonus_ids\": []\n }\n ]\n}"}],"_postman_id":"ac6d46b5-2034-4faa-85d5-1e45b580f4b4"},{"name":"Retrieve a module","id":"7359c9d8-e065-497e-a006-aed4085773da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/modules/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","modules",":id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

the identifier of the module

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e374dc89-f09b-4a9f-84c6-8dcb4e24d3c6","name":"Show","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/modules/710"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 710,\n \"title\": \"Introduction\",\n \"position\": 1,\n \"masterclass\": {\n \"id\": 92,\n \"title\": \"Instagram\"\n },\n \"lesson_ids\": [\n [1, 1317],\n [2, 1318],\n [3, 1319],\n [4, 1320],\n [5, 1321],\n [6, 1322],\n [7, 1323]\n ],\n \"milestone_ids\": [\n [8, 1324]\n ],\n \"bonus_ids\": []\n }\n}"}],"_postman_id":"7359c9d8-e065-497e-a006-aed4085773da"}],"id":"2c2f91b8-fe3c-4db2-861e-7315f280b441","description":"

Modules are the equivalent of chapters for a masterclass.

A module contains the following informations:

a title,
a position, to order modules inside a masterclass,
a masterclass_id,
a list of ordered lesson_ids,
a list of ordered milestone_ids,
a list of ordered bonus_ids.

\n","_postman_id":"2c2f91b8-fe3c-4db2-861e-7315f280b441","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Note","item":[{"name":"Retrieve notes","id":"8b5aaafd-cf6c-4974-a644-b4d30c663ef1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/notes?objective_id=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","notes"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

(optional) if present, the objective id of the steps, else, the objective id is the current user's objective id

\n","type":"text/plain"},"key":"objective_id","value":""}],"variable":[]}},"response":[{"id":"5d797fc7-82aa-4c30-928c-7419ffa489b0","name":"Index","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/notes?objective_id=","host":["https://api.livementor.com"],"path":["v1","notes"],"query":[{"key":"objective_id","value":"","description":"(optional) if present, the objective id of the steps, else, the objective id is the current user's objective id"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 4537,\n \"content\": \"An old note\",\n \"created_at\": \"2021-06-07T08:24:28.377Z\",\n \"updated_at\": \"2021-06-07T08:24:28.377Z\",\n \"author\": null,\n \"objective_id\": 7563\n },\n {\n \"id\": 4538,\n \"content\": \"A recent note from the student\",\n \"created_at\": \"2021-06-07T08:35:08.344Z\",\n \"updated_at\": \"2021-06-07T08:35:08.344Z\",\n \"author\": {\n \"id\": 3495,\n \"given_name\": \"Michel\",\n \"family_name\": \"Dupont\"\n },\n \"objective_id\": 7563\n },\n {\n \"id\": 4539,\n \"content\": \"A note from the mentor\",\n \"created_at\": \"2021-06-07T08:38:23.338Z\",\n \"updated_at\": \"2021-06-07T08:41:03.774Z\",\n \"author\": {\n \"id\": 234,\n \"given_name\": \"Frédérique\",\n \"family_name\": \"Benoit\"\n },\n \"objective_id\": 7563\n }\n ],\n \"total_items\": 3,\n \"pagination\": {\n \"current_page\": \"/v1/notes?objective_id=7563&page=1\",\n \"first_page\": \"/v1/notes?objective_id=7563&page=1\",\n \"last_page\": \"/v1/notes?objective_id=7563&page=1\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"8b5aaafd-cf6c-4974-a644-b4d30c663ef1"},{"name":"Create note","id":"34255bec-6720-42c5-a638-ca6ac342ec64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"content","value":"A note text","description":"

The content of the note

\n","type":"text"}]},"url":"https://api.livementor.com/v1/notes?objective_id=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","notes"],"host":["https://api.livementor.com"],"query":[{"key":"objective_id","value":""}],"variable":[]}},"response":[],"_postman_id":"34255bec-6720-42c5-a638-ca6ac342ec64"},{"name":"Update note","id":"8a73d6d6-8da2-4763-96cb-21015ac5f488","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"content","value":"An updated note text","description":"

The new content of the note to update

\n","type":"text"}]},"url":"https://api.livementor.com/v1/notes/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","notes",":id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

The identifier of the note to update

\n","type":"text/plain"},"type":"any","value":"5","key":"id"}]}},"response":[],"_postman_id":"8a73d6d6-8da2-4763-96cb-21015ac5f488"},{"name":"Delete note","id":"119d207d-9028-46f8-8b7e-5460f8ca6f05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.livementor.com/v1/notes/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","notes",":id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

The identifier of the note to delete

\n","type":"text/plain"},"type":"any","value":"4","key":"id"}]}},"response":[],"_postman_id":"119d207d-9028-46f8-8b7e-5460f8ca6f05"}],"id":"1f2a0571-ad93-46d3-9655-79bd6212c600","description":"

Notes are additional informations to a student's project. A student can have multiple notes associated to their objective.

A student and a mentor can read and create notes for any objective they have access to. They can update and delete notes they wrote themselves.

It is represented by the following information:

a content,
an author,
the objective_id of the objective the note belongs to.

\n","_postman_id":"1f2a0571-ad93-46d3-9655-79bd6212c600","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Objective","item":[{"name":"Retrieve an objective","id":"c7b6bf5f-9ec0-4101-b74b-16ae52367773","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/objective?project_id=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","objective"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

(optional) if present, the project id of the objective, else, the project id is the current user's project id

\n","type":"text/plain"},"key":"project_id","value":""}],"variable":[]}},"response":[{"id":"f0f1c780-ebee-479c-9493-3a09eb45b835","name":"Show","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/objective?project_id=8720","host":["https://api.livementor.com"],"path":["v1","objective"],"query":[{"key":"project_id","value":"8720"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 7563,\n \"title\": \"Développer mon activité en freelance\",\n \"ended_at\": null,\n \"project_id\": 8720\n }\n}"}],"_postman_id":"c7b6bf5f-9ec0-4101-b74b-16ae52367773"},{"name":"Update an objective","id":"6122085b-765f-4b1f-b757-a97108419f4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"\"My project objective\"","description":"

The title of the objective

\n","type":"text"}]},"url":"https://api.livementor.com/v1/objective?project_id=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","objective"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

(optional) if present, the project id of the objective, else, the project id is the current user's project id

\n","type":"text/plain"},"key":"project_id","value":""}],"variable":[]}},"response":[],"_postman_id":"6122085b-765f-4b1f-b757-a97108419f4f"}],"id":"cf585087-c1f0-4d0d-8e41-e352477055cd","description":"

The objective is a goal set by a student and their mentor regarding their project.

A student can only read their own objective, a mentor can read and update any objective.

It is represented by the following information:

a title,
an ended_at date, if the objective has been reached,
the project_id of the project the objective belongs to.

\n","_postman_id":"cf585087-c1f0-4d0d-8e41-e352477055cd","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Sales","item":[{"name":"Sales owner","id":"5f207a1d-7f98-482b-831d-00dbd7841559","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.livementor.com/v1/sales/sales_owner","urlObject":{"path":["v1","sales","sales_owner"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"3cbbc069-498b-4657-993d-6198358ff01b","name":"Retrieve user Sales owner","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/sales/sales_owner"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"f735c026e884f112022e2358c58795fb\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"68288af0-7bd2-4207-95df-82f57a5ed729"},{"key":"X-Runtime","value":"2.209552"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"name\": \"Mon conseiller pédagogique\",\n \"calendar_url\": \"https://meetings.hubspot.com/nicolas-chabrol/calendrier-livementor?embed=true\",\n \"email\": null\n }\n}"}],"_postman_id":"5f207a1d-7f98-482b-831d-00dbd7841559"},{"name":"Booking confirmation","id":"868371cb-de0c-4367-be0d-05edabbd449b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.livementor.com/v1/sales/booking_confirmation","urlObject":{"path":["v1","sales","booking_confirmation"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"c546af3a-037d-4468-acf3-b420d4f5c2c4","name":"Booking confirmation","originalRequest":{"method":"POST","header":[],"url":"https://api.livementor.com/v1/sales/booking_confirmation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"a58aab6ea5178b9ea82e9b99af805c74\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"53177b11-05dc-43cd-bc30-9d1f5c223352"},{"key":"X-Runtime","value":"0.469508"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": \"ok\"\n}"}],"_postman_id":"868371cb-de0c-4367-be0d-05edabbd449b"},{"name":"Ask for call","id":"78cbbb67-f6b6-464c-acff-8beabf3e4271","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://api.livementor.com/v1/sales/ask_for_call?phone_number=0642424242","urlObject":{"path":["v1","sales","ask_for_call"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

The lead phone number to call

\n","type":"text/plain"},"key":"phone_number","value":"0642424242"}],"variable":[]}},"response":[{"id":"d617a332-0cb1-40ec-ad14-25698d9f9571","name":"Ask for call with a phone number","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.livementor.com/v1/sales/ask_for_call?phone_number=0642424242","host":["https://api.livementor.com"],"path":["v1","sales","ask_for_call"],"query":[{"key":"phone_number","value":"0642424242","description":"The lead phone number to call","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"075d659c869f8fd2ee0df010fe8e5e95\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"8023a725-af6a-43ef-a9f6-956d8beee29d"},{"key":"X-Runtime","value":"3.628298"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": true\n}"}],"_postman_id":"78cbbb67-f6b6-464c-acff-8beabf3e4271"}],"id":"1f61bbbe-d857-4aa1-af1b-271a9dfd8c46","description":"

The Sales controller allows to make request about Booking a sales meeting in Hubspot, Retrieving the sales deal owner of the authenticated user, asking to be called back by a sales...

\n","_postman_id":"1f61bbbe-d857-4aa1-af1b-271a9dfd8c46","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Stats","item":[{"name":"Retrieve stats","id":"f3281b6d-18aa-438b-aa8c-6e07cc8b823b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/stats","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","stats"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[{"id":"71677559-9632-438f-af13-520d54a254dc","name":"Show","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/stats"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"average_response_time\": 82240,\n \"current_student_assignments\": 21,\n \"total_student_assignments\": 440\n }\n}"}],"_postman_id":"f3281b6d-18aa-438b-aa8c-6e07cc8b823b"}],"id":"d76cbe70-4d88-40be-bbd5-ead8c57f881b","description":"

Stats are objects that contain various metrics about the current user.

For students, no stats are implemented at the moment.

For mentors:

average_response_time: the average time in seconds to answer an unread message,
current_student_assignments: the count of assigned students who are currently in a training course,
total_student_assignments: the count of assigned students.

\n","_postman_id":"d76cbe70-4d88-40be-bbd5-ead8c57f881b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Step","item":[{"name":"Retrieve steps","id":"1d20cee5-f64b-4d50-8a67-fa076b7eeb78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/steps?objective_id=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","steps"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

(optional) if present, the objective id of the steps, else, the objective id is the current user's objective id

\n","type":"text/plain"},"key":"objective_id","value":""}],"variable":[]}},"response":[{"id":"745888f4-2029-45c0-b84a-98b349d527e6","name":"Index","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/steps?objective_id=6701","host":["https://api.livementor.com"],"path":["v1","steps"],"query":[{"key":"objective_id","value":"6701","description":"(optional) if present, the objective id of the steps, else, the objective id is the current user's objective id"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 15661,\n \"title\": \"Créer le portrait robot de son persona\",\n \"position\": 1,\n \"status\": \"pending\",\n \"ended_at\": null,\n \"objective_id\": 6701\n },\n {\n \"id\": 15676,\n \"title\": \"Bâtir la stratégie d'acquisition optimale par rapport au persona\",\n \"position\": 2,\n \"status\": \"pending\",\n \"ended_at\": null,\n \"objective_id\": 6701\n }\n ],\n \"total_items\": 2,\n \"pagination\": {\n \"current_page\": \"/v1/steps?objective_id=6701&page=1&step%5Btitle%5D=Test+step&title=Test+step\",\n \"first_page\": \"/v1/steps?objective_id=6701&page=1&step%5Btitle%5D=Test+step&title=Test+step\",\n \"last_page\": \"/v1/steps?objective_id=6701&page=1&step%5Btitle%5D=Test+step&title=Test+step\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"1d20cee5-f64b-4d50-8a67-fa076b7eeb78"},{"name":"Create step","id":"f5af6cc3-9a72-41b2-90a3-ec8262f01683","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"title","value":"Mon étape","description":"

The title of the step

\n","type":"text"}]},"url":"https://api.livementor.com/v1/steps?objective_id=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","steps"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

(optional) if present, the objective id of the steps, else, the objective id is the current user's objective id

\n","type":"text/plain"},"key":"objective_id","value":""}],"variable":[]}},"response":[],"_postman_id":"f5af6cc3-9a72-41b2-90a3-ec8262f01683"},{"name":"Update step","id":"97c62225-78b1-44ad-a5d5-c7c993351cc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"title","value":"Mon étape","description":"

(optional) The title of the step

\n","type":"text"},{"key":"position","value":"4","description":"

(optional) The new position of the step (in the context of the objective). The following steps' position will be recomputed automatically.

\n","type":"text"}]},"url":"https://api.livementor.com/v1/steps/:step_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","steps",":step_id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

The identifier of the step to update

\n","type":"text/plain"},"type":"any","value":"34","key":"step_id"}]}},"response":[],"_postman_id":"97c62225-78b1-44ad-a5d5-c7c993351cc1"},{"name":"Delete step","id":"89d52c88-7c1d-4b5c-9625-bf74819460b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.livementor.com/v1/steps/:step_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","steps",":step_id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

The identifier of the step to delete

\n","type":"text/plain"},"type":"any","value":"34","key":"step_id"}]}},"response":[],"_postman_id":"89d52c88-7c1d-4b5c-9625-bf74819460b0"},{"name":"Toggle step","id":"af2b851f-176d-4dea-8d52-4da2ffa2117e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.livementor.com/v1/steps/:step_id/toggle","description":"

A step can be marked as completed if it was previously pending, or marked as pending if it was previously completed.

This endpoint toggles the status from \"pending\" to \"completed\" or from \"completed\" to \"pending\", and properly sets the \"ended_at\" date to the date of completion, or to null (respectively).

The identifier of the step to toggle

\n","type":"text/plain"},"type":"any","value":"34","key":"step_id"}]}},"response":[],"_postman_id":"af2b851f-176d-4dea-8d52-4da2ffa2117e"}],"id":"ea66d7da-4c5a-4133-8d8c-8f3933d4f695","description":"

Steps are the milestones of a student's project. A student can have multiple steps associated to their objective.

A student can only read their own steps, a mentor can read, create, update, delete and validate any step.

It is represented by the following information:

a title,
a position, since steps are ordered inside an objective,
a status, that can either be 'pending' or 'completed',
an ended_at date, if the step has been completed,
the objective_id of the objective the step belongs to.

\n","_postman_id":"ea66d7da-4c5a-4133-8d8c-8f3933d4f695","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Task","item":[{"name":"Retrieve tasks","id":"25fa72db-9eb2-478b-b931-0dad1d784488","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/tasks?objective_id=&step_id=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","tasks"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

(optional) if present, only display tasks with this objective_id

\n","type":"text/plain"},"key":"objective_id","value":""},{"description":{"content":"

(optional) if present, only display tasks with this step_id

\n","type":"text/plain"},"key":"step_id","value":""}],"variable":[]}},"response":[{"id":"f9fa7029-94e9-46ad-8a5e-c0ccbb48a25b","name":"Index","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/tasks?objective_id=7563","host":["https://api.livementor.com"],"path":["v1","tasks"],"query":[{"key":"objective_id","value":"7563"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 50189,\n \"title\": \"Trouver un nom pour ma chaine YouTube\",\n \"content\": \"Par exemple \\\"Les expériences de Julien\\\"\",\n \"position\": 1,\n \"resources\": [\n \"https://www.youtube.com\"\n ],\n \"status\": \"completed\",\n \"ended_at\": \"2019-03-26T11:48:48.338Z\",\n \"objective_id\": 7563,\n \"step_id\": 18091\n },\n {\n \"id\": 50190,\n \"title\": \"Créer la chaine Youtube\",\n \"content\": null,\n \"position\": 2,\n \"resources\": [],\n \"status\": \"pending\",\n \"ended_at\": null,\n \"objective_id\": 7563,\n \"step_id\": 18091\n },\n {\n \"id\": 50191,\n \"title\": \"Monter ma première vidéo\",\n \"content\": \"Par exemple une vidéo de présentation de mon projet\",\n \"position\": 1,\n \"resources\": [],\n \"status\": \"pending\",\n \"ended_at\": null,\n \"objective_id\": 7563,\n \"step_id\": 18092\n }\n ],\n \"total_items\": 3,\n \"pagination\": {\n \"current_page\": \"/v1/tasks?objective_id=7563&page=1\",\n \"first_page\": \"/v1/tasks?objective_id=7563&page=1\",\n \"last_page\": \"/v1/tasks?objective_id=7563&page=1\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"25fa72db-9eb2-478b-b931-0dad1d784488"},{"name":"Create task","id":"caa555ad-f298-4e48-b86d-f94719d772bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"A new task","type":"text"},{"key":"content","value":"Some details about the task","description":"

(optional)

\n","type":"text"},{"key":"position","value":"Position of the task","description":"

(optional) if missing, creates the task after the previous one

\n","type":"text"},{"key":"resources[]","value":"https://example.com/url1","description":"

(optional) a list of URLs

\n","type":"text"},{"key":"resources[]","value":"https://example.com/url2","type":"text"}]},"url":"https://api.livementor.com/v1/tasks?step_id=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","tasks"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

The identifier of the step for the created task

\n","type":"text/plain"},"key":"step_id","value":""}],"variable":[]}},"response":[],"_postman_id":"caa555ad-f298-4e48-b86d-f94719d772bb"},{"name":"Update task","id":"6dedfaed-1e72-4403-aac9-d379c0eae9da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"A new task","type":"text","description":"

(optional)

\n"},{"key":"content","value":"Some details about the task","description":"

(optional)

\n","type":"text"},{"key":"position","value":"Position of the task","description":"

(optional) if missing, creates the task after the previous one

\n","type":"text"},{"key":"resources[]","value":"https://example.com/url1","description":"

(optional) a list of URLs

\n","type":"text"},{"key":"resources[]","value":"https://example.com/url2","type":"text"}]},"url":"https://api.livementor.com/v1/tasks/:task_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","tasks",":task_id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

the identifier of the task to update

\n","type":"text/plain"},"type":"any","value":"25","key":"task_id"}]}},"response":[],"_postman_id":"6dedfaed-1e72-4403-aac9-d379c0eae9da"},{"name":"Delete task","id":"b5092a85-ddbb-407c-93cb-e3e7de02d733","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.livementor.com/v1/tasks/:task_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","tasks",":task_id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

the identifier of the task to delete

\n","type":"text/plain"},"type":"any","value":"56","key":"task_id"}]}},"response":[],"_postman_id":"b5092a85-ddbb-407c-93cb-e3e7de02d733"},{"name":"Check task","id":"d5e608e2-0286-41b3-9a23-cfc8c95c62ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.livementor.com/v1/tasks/:task_id/check","description":"

A task can be marked as completed.

This endpoint changes the status to \"completed\" and properly sets the \"ended_at\" date to the date of completion.

A task can be marked as pending.

This endpoint changes the status to \"pending\" and properly sets the \"ended_at\" date to null.

A task can be marked as dropped (or paused).

This endpoint changes the status to \"dropped\" and properly sets the \"ended_at\" date to the date of dropping.

Tasks are completable elements of a step, items of a to-do list. A student can have multiple tasks per step.

A student can only read, update, delete, check, uncheck and drop (pause) their own tasks, and create new tasks on their own steps. A mentor can do all of the above on any task.

It is represented by the following information:

a title,
a content,
an array of resources containing URLs,
a position, since tasks are ordered inside a step,
a status, that can either be 'pending', 'completed', or 'dropped'
an ended_at date, if the step has been completed or dropped,
the objective_id of the objective the task belongs to,
the step_id of the step the task belongs to.

\n","_postman_id":"a19b14b5-f17a-4d3a-9e77-758124a38e23","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Training Course","item":[{"name":"Retrieve training courses","id":"7e773cc5-0ff1-4494-8df0-f5d4eab6774f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/training_courses?student=123456","description":"

Get a list of training courses

Identifier of the student

\n","type":"text/plain"},"key":"student","value":"123456"}],"variable":[]}},"response":[{"id":"4936e84a-e024-4aff-9f61-15e4431e355b","name":"Index","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/training_courses?student=123456","host":["https://api.livementor.com"],"path":["v1","training_courses"],"query":[{"key":"student","value":"123456","description":"Identifier of the student"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"03d7e4fabddc83c865a35a70dbe63c5f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"94ad1a52-7109-4691-80ce-b5f9582cabe1"},{"key":"X-Runtime","value":"0.922658"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"certification_id\": 123,\n \"student_id\": 123456,\n \"onboarding_progression\": \"pending\",\n \"evaluation_mode\": \"auto\",\n \"reviewer_kind\": \"internal\",\n \"with_coaching\": true,\n \"edition_batch_id\": 456,\n \"masterclass\": {\n \"id\": 123,\n \"slug\": \"socrate-avance\",\n \"title\": \"Socrate\"\n },\n \"deepening\": \"Socrate Avanc\\u00e9\",\n \"manual_only\": [\n \"Excel\",\n \"PowerPoint\"\n ],\n \"kind\": {\n \"name\": \"Formation 3 mois\",\n \"public_market\": false,\n \"key\": \"3_months\"\n },\n \"administrative_dates\": {\n \"start\": \"2020-05-20\",\n \"end\": \"2020-06-19\"\n },\n \"access_dates\": {\n \"start\": \"2020-05-21\",\n \"end\": \"2020-09-18\"\n },\n \"mentor\": {\n \"id\": 456789,\n \"first_name\": \"Monica\",\n \"last_name\": \"K...\",\n \"picture\": \"/system/users/avatars/000/296/214/large/IMG_20200324_081324.jpg?1588242759\"\n },\n \"evaluator\": {\n \"id\": 789012,\n \"first_name\": \"Jean\"\n },\n \"course_plan\": {\n \"name\": \"Formation Socrate 3 mois\",\n \"label\": \"Socrate - 3 mois\",\n \"public_market\": true,\n \"meeting_intensity\": \"weekly\",\n \"certification_delay\": 30,\n \"total_duration\": 90,\n \"duration_after_administrative_end\": 60,\n \"additional_link\": \"https://example.com/additional-resources\"\n },\n \"details\": {\n \"certification_status\": \"in_progress\",\n \"completion_percentage\": 65,\n \"next_milestone\": \"Module 3 completion\"\n },\n \"flagged_for_testimonial_at\": \"2020-08-15T10:30:00.000Z\"\n }\n ],\n \"total_items\": 1,\n \"pagination\": {\n \"current_page\": \"/v1/training_courses?page=1&student=123456\",\n \"first_page\": \"/v1/training_courses?page=1&student=123456\",\n \"last_page\": \"/v1/training_courses?page=1&student=123456\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"7e773cc5-0ff1-4494-8df0-f5d4eab6774f"},{"name":"Retrieve a training course","id":"3f4fbf65-8a70-42b6-b19e-f7f62cd1f22e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/training_courses/{{training_course_id}}","description":"

Get a specific training course by ID

Training courses are the objects used to depict a student following a training on LiveMentor.

It is represented by the following information:

a student: the student following the training course
a mentor: the mentor coaching the student in its training course
a masterclass: the main topic of the training course
some administrative dates: official training courses dates. Usually 25 working days
some accesses dates: actual accesses dates to coachings. Usually 3 months (1 certifying month + 2 extra coaching months)
a certification: all our trianing courses are now certifying and linked to a certification object

\n","event":[{"listen":"prerequest","script":{"id":"69cbbd0f-6d6c-43df-8148-c7ab741fd0c5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"95ce9729-1512-4f97-baf9-728957559728","type":"text/javascript","exec":[""]}}],"_postman_id":"7a7756bf-604d-4ab6-97db-ac5fced76a15","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"User","item":[{"name":"Lookup","id":"77c2241d-606f-48a4-b4e2-b62e98adf042","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/users/lookup?email=kuhn_jan+qa-10@wolff.net&id=10","description":"

Allow the connected user to find a user by his email or by is id

Email of the user to lookup

\n","type":"text/plain"},"key":"email","value":"kuhn_jan+qa-10@wolff.net"},{"description":{"content":"

Identifier of the user to lookup

\n","type":"text/plain"},"key":"id","value":"10"}],"variable":[]}},"response":[{"id":"d4d75d9b-66d8-430a-be07-8c48bb5da058","name":"Lookup","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/users/lookup?email=john.doe@mail.com","host":["https://api.livementor.com"],"path":["v1","users","lookup"],"query":[{"key":"email","value":"john.doe@mail.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"71135eeccded6879d9ff8abeaf420048\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"39675303-005b-4a2a-a5ea-2956ffbd76b2"},{"key":"X-Runtime","value":"0.030509"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 123456,\n \"email\": \"john.doe@mail.com\",\n \"avatar\": \"/john-doe.jpg\",\n \"name\": \"John Doe\",\n \"role\": \"student\",\n \"is_currently_in_pause\": false\n }\n}"}],"_postman_id":"77c2241d-606f-48a4-b4e2-b62e98adf042"},{"name":"Retrieve a user","id":"a4741974-418a-464f-8542-0c827321ae9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/users/:id","description":"

Retreive generic user information.

The following syntax can also be used to retrieve current user information:

/api/users/me\n\n

Each user has a role that can either be mentor or student.

Each student can also has one or more statuses:

reader : a student who has access to some content in the library.
\n
future_student : a student who will be starting one or more new training courses in the future
\n
current_student : a student who is currently following a training course
\n
past_student : a student who followed one or more training courses that are now over
\n
webinars : the student can join live webinars
\n
webinar_replays : the student can watch webinars replays
\n
current_edition : the student follow an edition hot seats
\n
past_edition : the student had follow an edition hot seats
\n
future_edition: the student will follow an edition hot seats
\n
community : the student can access to community view
\n
internal_candidate : the student need to pass a certification exam with an evaluator as internal candidate.
\n
ai_copilot : the user has access to ai_copilot
\n

Identifier of the user to retrieve info from

\n","type":"text/plain"},"type":"any","value":"123456","key":"id"}]}},"response":[{"id":"dab6a8e3-67a7-4b1d-b7bf-d54b894cae0e","name":"Show","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/users/:id","host":["https://api.livementor.com"],"path":["v1","users",":id"],"variable":[{"key":"id","value":"123456","description":"Id of the user to retrieve info from. Special \"me\" key can be used here to retreive your own account information"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"2bdb020ead62d30c9e2f8fcd70f17ede\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"5cb12de1-3885-42b4-8e5a-0a898beecd05"},{"key":"X-Runtime","value":"0.182079"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 330377,\n \"given_name\": \"Kristie\",\n \"family_name\": \"Gislason\",\n \"email\": \"kristie_gislason@bogisich-kassulke.co\",\n \"phone_number\": null,\n \"picture\": \"/john-doe.jpg\",\n \"role\": \"student\",\n \"feature_flags\": [\n \"pedagogic_file\",\n \"new_mentor_invoicing\",\n \"community_map\",\n \"community\",\n \"future_kickoff_button\",\n \"session_log\",\n \"assiduity_doc\"\n ],\n \"firebase_password\": \"0a63103b4dd08ec01566452df860e2b4\",\n \"tmp_password\": false,\n \"student\": {\n \"status\": [\n \"reader\",\n \"current_student\",\n \"webinars\",\n \"webinar_replays\",\n \"community\"\n ],\n \"coaching_status\": \"not_started\",\n \"reference_mentor_id\": 294733,\n \"project_id\": 30841,\n \"should_refresh_introduction_form\": false,\n \"onboarding_required\": false,\n \"training_course_id_to_onboard\": null,\n \"training_course_to_onboard_start_date\": null,\n \"training_course_id_waiting_for_mentor\": null,\n \"current_training_course_id\": 151094,\n \"current_candidate_certification_id\": null,\n \"active_pause\": null,\n \"available_coaching_access\": {\n \"start_at\": \"2025-01-15T00:00:00.000+01:00\",\n \"end_at\": \"2025-04-11T23:59:59.999+02:00\"\n },\n \"accepted_tos_at\": null,\n \"has_community_profile\": false\n }\n }\n}"},{"id":"d2b0a3a6-cfbe-48e8-a238-daef879a9886","name":"Show internal candidate","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/users/:id","host":["https://api.livementor.com"],"path":["v1","users",":id"],"variable":[{"key":"id","value":"330410","description":"Identifier of the user to retrieve info from"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 330410,\n \"given_name\": \"Tam\",\n \"family_name\": \"Krajcik\",\n \"email\": \"krajcik.tam@oconner.info\",\n \"phone_number\": null,\n \"picture\": \"/john-doe.jpg\",\n \"role\": \"student\",\n \"feature_flags\": [\n \"pedagogic_file\",\n \"new_mentor_invoicing\",\n \"community_map\",\n \"community\",\n \"future_kickoff_button\",\n \"session_log\",\n \"assiduity_doc\"\n ],\n \"firebase_password\": null,\n \"tmp_password\": false,\n \"student\": {\n \"status\": [\n \"internal_candidate\"\n ],\n \"coaching_status\": \"not_started\",\n \"reference_mentor_id\": null,\n \"project_id\": null,\n \"should_refresh_introduction_form\": false,\n \"onboarding_required\": false,\n \"training_course_id_to_onboard\": null,\n \"training_course_to_onboard_start_date\": null,\n \"training_course_id_waiting_for_mentor\": null,\n \"current_training_course_id\": null,\n \"current_candidate_certification_id\": 149770,\n \"active_pause\": null,\n \"available_coaching_access\": null,\n \"accepted_tos_at\": null,\n \"has_community_profile\": false\n }\n }\n}"}],"_postman_id":"a4741974-418a-464f-8542-0c827321ae9f"},{"name":"[Deprecated] List courses","id":"099aff43-1de0-4748-b0cd-e31efde3c35c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/users/:id/courses","description":"

List courses a user has access to.

This endpoint is deprecated and will soon be removed.\nUse Masterclass > Retrieve Masterclasses endpoint instead.

Identifier of the student following the training courses

\n","type":"text/plain"},"type":"any","value":"123456","key":"id"}]}},"response":[{"id":"a9907585-93df-4c7e-9714-661e05ce35fe","name":"Courses","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/users/:id/courses","host":["https://api.livementor.com"],"path":["v1","users",":id","courses"],"variable":[{"key":"id","value":"123456","description":"Id of the user to retrieve info from. Special \"me\" key can be used here to retreive your own account information"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"6d8efc7f3f18c7201f7811fffc1e51b1\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"57878b90-6ca8-4c30-b930-1bf7ae891dbf"},{"key":"X-Runtime","value":"0.525078"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"user_id\": 123456,\n \"courses\": [\n {\n \"title\": \"L'accélérateur\",\n \"slug\": \"acceleterateur\"\n },\n {\n \"title\": \"Advanced English\",\n \"slug\": \"advanced-english\"\n },\n {\n \"title\": \"Le réseau\",\n \"slug\": \"bootcamp-reseau\"\n },\n {\n \"title\": \"Lancer son commerce de proximité\",\n \"slug\": \"commerce-proximite\"\n },\n {\n \"title\": \"Copywriting\",\n \"slug\": \"copywriting-formation-entrepreneurs\"\n },\n {\n \"title\": \"Dropshipping\",\n \"slug\": \"formation-dropshipping\"\n },\n {\n \"title\": \"Facebook Domination\",\n \"slug\": \"facebook-advanced-english\"\n },\n {\n \"title\": \"Formation Facebook\",\n \"slug\": \"facebook-formation\"\n },\n {\n \"title\": \"Freelance\",\n \"slug\": \"freelance-formation\"\n },\n {\n \"title\": \"Freelance & Coach\",\n \"slug\": \"freelance-coach\"\n },\n {\n \"title\": \"IMPACT Partenaire\",\n \"slug\": \"impact-partenaire\"\n },\n {\n \"title\": \"Instagram\",\n \"slug\": \"formation-instagram\"\n },\n {\n \"title\": \"Formation WordPress\",\n \"slug\": \"wordpress-formation\"\n },\n {\n \"title\": \"Marketing Digital\",\n \"slug\": \"formation-marketing-digital\"\n },\n {\n \"title\": \"Productivité\",\n \"slug\": \"formation-productivité\"\n },\n {\n \"title\": \"Socrate\",\n \"slug\": \"socrate-avance\"\n },\n {\n \"title\": \"Vasco de Gama\",\n \"slug\": \"vasco-de-gama-avance\"\n }\n ],\n \"tripwires\": [\n {\n \"title\": \"Envolée Freelance\",\n \"slug\": \"envolee-freelance\"\n },\n {\n \"title\": \"J'aime Enseigner\",\n \"slug\": \"jaime-enseigner\"\n },\n {\n \"title\": \"L'Oeil de Moscou\",\n \"slug\": \"oeil-de-moscou\"\n },\n {\n \"title\": \"Pack Wordpress\",\n \"slug\": \"pack-wordpress\"\n },\n {\n \"title\": \"Pack Instagram\",\n \"slug\": \"pack_instagram\"\n },\n {\n \"title\": \"Réussir dans le e-commerce\",\n \"slug\": \"reussir-ecommerce\"\n },\n {\n \"title\": \"Thérapeutes, lancez-vous !\",\n \"slug\": \"therapeutes-lancez-vous\"\n }\n ]\n }\n}"}],"_postman_id":"099aff43-1de0-4748-b0cd-e31efde3c35c"},{"name":"Retrieve a user profile","id":"5dc7fc0c-dd6e-45ab-b9b4-c60ba2322f3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/users/:id/profile","description":"

Retrieve user's profile informations.

Students can retrieve their own profile informations, mentors can retrieve any user's profile informations.

For any user, this endpoint returns :

id, given_name, family_name,
picture: the URL of the user's profile picture,

For students, it also returns :

email, birthday
gender: can be 'male', 'female', 'non_binary', or null,
address:
- line, postal_code, city, country
\n

For mentors, it also returns :

tagline,
bio: an HTML formatted text with the mentor's biography,
labels: a list of thematic labels.

Identifier of the user to retrieve info from, or \"me\"

\n","type":"text/plain"},"type":"any","value":"23560","key":"id"}]}},"response":[{"id":"b6c6c1fa-62eb-47f0-ad64-43e30a5e83be","name":"Student","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/users/me/profile"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 12853,\n \"given_name\": \"Anna\",\n \"family_name\": \"Mason\",\n \"picture\": \"/system/users/avatars/000/012/853/medium/43.jpg?1618492348\",\n \"email\": \"anna.masson@example.com\",\n \"birthday\": \"1982-01-14T00:00:00.000Z\",\n \"gender\": \"female\",\n \"address\": {\n \"line\": \"58 Boulevard de la Duchère\",\n \"postal_code\": \"37374\",\n \"city\": \"Tours\",\n \"country\": \"France\"\n }\n }\n}"},{"id":"15cbb8c4-c40d-4962-9c69-f87e479cd588","name":"Mentor","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/users/24938/profile"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 24938,\n \"given_name\": \"Luis\",\n \"family_name\": \"Roussel\",\n \"picture\": \"/system/users/avatars/000/024/938/medium/43.jpg?1618492447\",\n \"tagline\": \"Online Space Hacker\",\n \"bio\": \"

Je suis un faux mentor qui teste notre produit

\",\n \"labels\": [\n \"Marketing Digital\",\n \"Gestion de projet\",\n \"Stratégie de contenu\"\n ]\n }\n}"}],"_postman_id":"5dc7fc0c-dd6e-45ab-b9b4-c60ba2322f3d"},{"name":"Update a user profile","id":"5b601d5a-ac27-41ea-8c41-2a447c02c79c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"given_name","value":"Michel","type":"text"},{"key":"family_name","value":"Dupont","type":"text"},{"key":"picture","description":"

an image file

\n","type":"file","value":null},{"key":"email","value":"michel.dupont@example.com","description":"

(only for students)

\n","type":"text"},{"key":"birthday","value":"1982-01-14","description":"

(only for students) a datetime

\n","type":"text"},{"key":"gender","value":"female","description":"

(only for students) can be 'male', 'female' or 'non_binary'

\n","type":"text"},{"key":"address[line]","value":"58 Boulevard de la Duchère","description":"

(only for students)

\n","type":"text"},{"key":"addres[postal_code]","value":"37374","description":"

(only for students)

\n","type":"text"},{"key":"address[city]","value":"Tours","description":"

(only for students)

\n","type":"text"},{"key":"address[country]","value":"France","description":"

(only for students) defaults to 'France' if left empty

\n","type":"text"},{"key":"tagline","value":"Space Hacker","description":"

(only for mentors) a description of the job or activity

\n","type":"text"},{"key":"bio","value":"

I'm a philantrope entrepreneur

","description":"

(only for mentors) an html formatted description

\n","type":"text"},{"key":"labels[]","value":"Marketing","description":"

(only for mentors) a list of labels

\n","type":"text"},{"key":"labels[]","value":"Content","description":"

(only for mentors) a list of labels

\n","type":"text"}]},"url":"https://api.livementor.com/v1/users/:id/profile","description":"

Any set of attributes (except id) returned by the GET endpoint can be sent as form data or JSON payload.

Identifier of the user to retrieve info from, or \"me\"

\n","type":"text/plain"},"type":"any","value":"23560","key":"id"}]}},"response":[],"_postman_id":"5b601d5a-ac27-41ea-8c41-2a447c02c79c"},{"name":"Retrieve a user project","id":"36b12a0c-9ba1-4d2e-aba9-c37fd0ce5a09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/users/:id/project","description":"

Retrieve user's project informations.

Mentors can retrieve any user's project informations.

This endpoint returns all onboarding responses, in this format :

 \"user__study_level\": { \n     \"title\": \"Quel est votre niveau d'étude ?\", \n     \"value\": \"Au delà de Bac +5\" \n}\n\n

Deprecated fields :

goal: selected in a list of goals,
\n
project_stage: selected in a list of project stages,
\n
business_sector: selected in a list of business sectors,
\n
description: text field,
\n
next_months: text field,
\n
website_url: URL,
\n
facebook_page_url: URL,
\n
instagram_url: URL,
\n
parallel_activity: text field,
\n
time_spent: can be \"5\" (less than 5 hours a week), \"10\" (5 to 10 hours a week) or \"15\" (more than 10 hours a week).
\n

Identifier of the user to retrieve info from, or \"me\"

\n","type":"text/plain"},"type":"any","value":"23560","key":"id"}]}},"response":[{"id":"25fab81e-5635-4cb7-ad71-a7db761d6f8f","name":"Show entrepreneur student for mentor","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/users/{{student_user_id}}/project"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"goal\": null,\n \"project_stage\": \"optimizing_existing\",\n \"business_sector\": null,\n \"project_id\": 33360,\n \"description\": \"xpliquez clairement ce que vous proposez, à qui cela s'adresse, le problème que vous cherchez à résoudre, pourquoi il est important, et comment vous comptez concrètement mettre votre solution en placexpliquez clairement ce quefvdsfvssdvsvxdvzefececeeddvtez concrètement mettre votre solution en place\",\n \"next_months\": \"Partagez-nous ce qui, à vos yeux, est le plus important pour avancer concrètement dans votre projet. Indiquez-nous ce que vous souhaitez apprendre, les résultats que vous voulez atteindre, les objectifs que vous aimeriez vous fixer.\\nPartagez-nous ce qui, à vos yeux, est le plus important pour avancer concrètement dans votre projet. Indiquez-nous ce que vous souhaitez apprendre, les résultats que vous voulez atteindre, les objectifs que vous aimeriez vous fixer.\\n\",\n \"website_url\": \"https://www.hellobank.fr/\",\n \"facebook_page_url\": null,\n \"instagram_url\": \"https://www.instagram.com/\",\n \"parallel_activity\": null,\n \"time_spent\": \"from_5_to_10\",\n \"user__given_name\": {\n \"title\": \"Prénom\",\n \"value\": null\n },\n \"user__family_name\": {\n \"title\": \"Nom\",\n \"value\": null\n },\n \"user__gender\": {\n \"title\": \"Genre\",\n \"value\": \"Femme\"\n },\n \"user__birthday\": {\n \"title\": \"Date de naissance\",\n \"value\": \"2012-01-18T01:00:00.000+01:00\"\n },\n \"user__handicap\": {\n \"title\": \"Êtes-vous en situation de handicap ?\",\n \"value\": \"Oui\"\n },\n \"user__learning_disability_kind\": {\n \"title\": \"Avez-vous un trouble de l'apprentissage que vous souhaitez nous signaler ?\",\n \"value\": \"Dysphasie - Trouble du langage oral, Dysorthographie - Trouble d'acquisition de l'orthographe\"\n },\n \"user__learning_disability_comment\": {\n \"title\": \"Si vous le souhaitez vous pouvez préciser votre trouble de l'apprentissage\",\n \"value\": null\n },\n \"user__study_level\": {\n \"title\": \"Quel est votre niveau d'étude ?\",\n \"value\": \"Au delà de Bac +5\"\n },\n \"user__pro_situation\": {\n \"title\": \"Comment définiriez-vous, à date, votre situation principale ?\",\n \"value\": \"Auto-entrepreneur\"\n },\n \"user__contract_kind\": {\n \"title\": \"Votre emploi salarié\",\n \"value\": \"CDI temps plein\"\n },\n \"user__executive_manager\": {\n \"title\": \"Avez-vous un statut Cadre ?\",\n \"value\": \"Non\"\n },\n \"user__training_goal\": {\n \"title\": \"Que souhaitez-vous accomplir avec votre formation ?\",\n \"value\": \"Je développe mon projet entrepreneurial\"\n },\n \"user__entrepreneur_experience\": {\n \"title\": \"Quelle est votre expérience en tant qu'entrepreneur ?\",\n \"value\": \"J'ai plusieurs expériences entrepreneuriales\"\n },\n \"user__professional_background_skills\": {\n \"title\": \"Quel est votre parcours professionnel et les compétences qui pourraient servir votre projet ?\",\n \"value\": \"Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!\"\n },\n \"user__time_spent\": {\n \"title\": \"Combien de temps pouvez-vous consacrer à votre projet chaque semaine ?\",\n \"value\": \"5 à 10 heures\"\n },\n \"user__personal_constraints\": {\n \"title\": \"Y a-t-il des contraintes personnelles dont vous aimeriez nous parler ?\",\n \"value\": \"Contraintes familiales, financières ou géographiques… Parlez-nous de ce qui pourrait ralentir votre projet.Contraintes familiales, financières ou géographiques… Parlez-nous de ce qui pourrait ralentir votre projet.\"\n },\n \"user__success_vision\": {\n \"title\": \"À quoi ressemblerait votre vie idéale, dans 3 ans ?\",\n \"value\": \"Parlez-nous de votre vision du succès : le style de vie que vous souhaitez, l'impact que vous voulez avoir, l'équilibre que vous recherchez entre vie pro et perso, etc.\\n\"\n },\n \"user__inspiring_people\": {\n \"title\": \"Quelles personnes vous inspirent dans votre projet ?\",\n \"value\": \"Parlez-nous de votre vision du succès : le style de vie que vous souhaitez, l'impact que vous voulez avoir, l'équilibre que vous recherchez entre vie pro et perso, etc.\\n\"\n },\n \"user__business_sector_parent\": {\n \"title\": \"Dans quel secteur évoluez-vous ?\",\n \"value\": \"Agro-alimentaire & Restauration\"\n },\n \"user__current_situation_review\": {\n \"title\": \"Quelles sont vos victoires et vos principaux défis ?\",\n \"value\": \"Expliquez comment vous comptez vous faire connaître, transformer vos prospects en clients, les fidéliser, et ce que vous envisagez de mettre en place.\\nExpliquez comment vous comptez vous faire connaître, transformer vos prospects en clients, les fidéliser, et ce que vous envisagez de mettre en place.\\n\"\n },\n \"user_project__motivations_goals\": {\n \"title\": \"Quelles sont vos motivations et vos objectifs avec ce projet ?\",\n \"value\": \"Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!\"\n },\n \"user_project__budget\": {\n \"title\": \"Quel budget pouvez-vous investir dans votre projet chaque année ?\",\n \"value\": \"5 000€ à 15 000€\"\n },\n \"user_project__available_resources\": {\n \"title\": \"À l'inverse, quelles sont les ressources déjà à votre disposition pour ce projet ?\",\n \"value\": \"Cela peut être un réseau, des outils, des compétences, un local ou tout autre atout déjà en votre possession.\\nCela peut être un réseau, des outils, des compétences, un local ou tout autre atout déjà en votre possession.\\n\"\n },\n \"user_project__description\": {\n \"title\": \"Pouvez-vous nous expliquer votre projet comme si l'on ne connaissait rien à votre domaine ?\",\n \"value\": \"xpliquez clairement ce que vous proposez, à qui cela s'adresse, le problème que vous cherchez à résoudre, pourquoi il est important, et comment vous comptez concrètement mettre votre solution en placexpliquez clairement ce quefvdsfvssdvsvxdvzefececeeddvtez concrètement mettre votre solution en place\"\n },\n \"user_project__stage\": {\n \"title\": \"Où en êtes-vous actuellement dans votre projet ?\",\n \"value\": \"Je veux développer mon activité existante\"\n },\n \"user_project__target_customers\": {\n \"title\": \"Que savez-vous de vos clients actuels ou futurs ?\",\n \"value\": \"Partagez ce que vous savez (ou pensez savoir) sur vos clients : à qui vous vous adressez, où les trouver, ce qu ils recherchent, leur budget, etc. Vous pouvez aussi mentionner les questions que vous vous posez encore.\\n\"\n },\n \"user_project__income_sources\": {\n \"title\": \"Quelles sont ou seront vos sources de revenus ?\",\n \"value\": \"Vente de produits physiques, Formations / coaching, Commissions / affiliation, Je ne sais pas, je compte sur vous pour m'aider\"\n },\n \"user_project__income_sources_comment\": {\n \"title\": \"Précisez votre modèle économique\",\n \"value\": null\n },\n \"user_project__offer_description\": {\n \"title\": \"Décrivez votre offre actuelle ou future : produits, services, offres spéciales\",\n \"value\": \"Parlez-nous de votre offre, même si elle est floue : ce que vous proposez ou aimeriez proposer, les évolutions possibles, et vos idées d'offres spéciales.\\nParlez-nous de votre offre, même si elle est floue : ce que vous proposez ou aimeriez proposer, les évolutions possibles, et vos idées d'offres spéciales.\\n\"\n },\n \"user_project__financial_plan\": {\n \"title\": \"Parlez nous de l'économie de votre projet : coûts, marges, rentabilité...\",\n \"value\": \"\"\n },\n \"user_project__customer_strategy\": {\n \"title\": \"Comment comptez-vous attirer et fidéliser vos clients ?\",\n \"value\": \"\"\n },\n \"user_project__next_months\": {\n \"title\": \"Quelles sont vos 3 priorités absolues pour les prochains mois ?\",\n \"value\": \"Partagez-nous ce qui, à vos yeux, est le plus important pour avancer concrètement dans votre projet. Indiquez-nous ce que vous souhaitez apprendre, les résultats que vous voulez atteindre, les objectifs que vous aimeriez vous fixer.\\nPartagez-nous ce qui, à vos yeux, est le plus important pour avancer concrètement dans votre projet. Indiquez-nous ce que vous souhaitez apprendre, les résultats que vous voulez atteindre, les objectifs que vous aimeriez vous fixer.\\n\"\n },\n \"user_project__monthly_income_goal\": {\n \"title\": \"Quel chiffre d'affaires mensuel visez-vous dans un an ?\",\n \"value\": \"1 000€ à 3 000€/mois\"\n },\n \"user_project__year_goals\": {\n \"title\": \"Quelles sont vos objectifs pour l'année ?\",\n \"value\": \"Partagez nous ce que vous aimeriez attendre d'ici un an : résultats concrets, évolution de votre projet ou de votre posture, nouvelles compétences à acquérir, etc.k\\nPartagez nous ce que vous aimeriez\\n\"\n },\n \"user_project__website_url\": {\n \"title\": \"Site web\",\n \"value\": \"https://www.hellobank.fr/\"\n },\n \"user_project__facebook_page_url\": {\n \"title\": \"Page Facebook\",\n \"value\": null\n },\n \"user_project__instagram_url\": {\n \"title\": \"Profil Instagram\",\n \"value\": \"https://www.instagram.com/\"\n },\n \"user_project__linkedin_url\": {\n \"title\": \"Profil LinkedIn\",\n \"value\": \"https://\"\n },\n \"user_project__youtube_url\": {\n \"title\": \"Chaine Youtube\",\n \"value\": null\n },\n \"user_project__tiktok_url\": {\n \"title\": \"Profil Tiktok\",\n \"value\": null\n }\n }\n}"},{"id":"6a6f78f3-c84f-4b29-b12a-944fa3425383","name":"Show Skills Boost student for mentor","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/users/{{student_user_id}}/project"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"goal\": null,\n \"project_stage\": \"optimizing_existing\",\n \"business_sector\": \"catering_professionnals\",\n \"project_id\": 33360,\n \"description\": \"xpliquez clairement ce que vous proposez, à qui cela s'adresse, le problème que vous cherchez à résoudre, pourquoi il est important, et comment vous comptez concrètement mettre votre solution en placexpliquez clairement ce quefvdsfvssdvsvxdvzefececeeddvtez concrètement mettre votre solution en place\",\n \"next_months\": \"Partagez-nous ce qui, à vos yeux, est le plus important pour avancer concrètement dans votre projet. Indiquez-nous ce que vous souhaitez apprendre, les résultats que vous voulez atteindre, les objectifs que vous aimeriez vous fixer.\\nPartagez-nous ce qui, à vos yeux, est le plus important pour avancer concrètement dans votre projet. Indiquez-nous ce que vous souhaitez apprendre, les résultats que vous voulez atteindre, les objectifs que vous aimeriez vous fixer.\\n\",\n \"website_url\": \"https://www.hellobank.fr/\",\n \"facebook_page_url\": null,\n \"instagram_url\": \"https://www.instagram.com/\",\n \"parallel_activity\": null,\n \"time_spent\": \"from_5_to_10\",\n \"user__given_name\": {\n \"title\": \"Prénom\",\n \"value\": null\n },\n \"user__family_name\": {\n \"title\": \"Nom\",\n \"value\": null\n },\n \"user__gender\": {\n \"title\": \"Genre\",\n \"value\": \"Femme\"\n },\n \"user__birthday\": {\n \"title\": \"Date de naissance\",\n \"value\": \"2012-01-18T01:00:00.000+01:00\"\n },\n \"user__handicap\": {\n \"title\": \"Êtes-vous en situation de handicap ?\",\n \"value\": \"Oui\"\n },\n \"user__learning_disability_kind\": {\n \"title\": \"Avez-vous un trouble de l'apprentissage que vous souhaitez nous signaler ?\",\n \"value\": \"Dysphasie - Trouble du langage oral, Dysorthographie - Trouble d'acquisition de l'orthographe\"\n },\n \"user__learning_disability_comment\": {\n \"title\": \"Si vous le souhaitez vous pouvez préciser votre trouble de l'apprentissage\",\n \"value\": null\n },\n \"user__study_level\": {\n \"title\": \"Quel est votre niveau d'étude ?\",\n \"value\": \"Au delà de Bac +5\"\n },\n \"user__pro_situation\": {\n \"title\": \"Comment définiriez-vous, à date, votre situation principale ?\",\n \"value\": \"Auto-entrepreneur\"\n },\n \"user__contract_kind\": {\n \"title\": \"Votre emploi salarié\",\n \"value\": \"CDI temps plein\"\n },\n \"user__executive_manager\": {\n \"title\": \"Avez-vous un statut Cadre ?\",\n \"value\": \"Non\"\n },\n \"user__training_goal\": {\n \"title\": \"Que souhaitez-vous accomplir avec votre formation ?\",\n \"value\": \"Je souhaite monter en compétence\"\n },\n \"user__professional_background_skills\": {\n \"title\": \"Quel est votre parcours professionnel, et quelles sont les principales compétences que vous avez développées en chemin ?\",\n \"value\": \"Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!Je suis très motivée !!!!!!!!!!\"\n },\n \"user__time_spent\": {\n \"title\": \"Combien de temps pouvez-vous consacrer à votre projet chaque semaine ?\",\n \"value\": \"5 à 10 heures\"\n },\n \"user__personal_constraints\": {\n \"title\": \"Y a-t-il des contraintes personnelles dont vous aimeriez nous parler ?\",\n \"value\": \"Contraintes familiales, financières ou géographiques… Parlez-nous de ce qui pourrait ralentir votre projet.Contraintes familiales, financières ou géographiques… Parlez-nous de ce qui pourrait ralentir votre projet.\"\n },\n \"user__business_sector_parent\": {\n \"title\": \"Dans quel secteur travaillez-vous actuellement (ou avez-vous travaillé) ?\",\n \"value\": \"Agro-alimentaire & Restauration\"\n },\n \"user__skills_motivation\": {\n \"title\": \"Pourquoi souhaitez-vous développer ces nouvelles compétences ?\",\n \"value\": \"Parlez-nous de ce qui vous pousse à vouloir progresser : un déclic, une réflexion en cours, des difficultés rencontrées, des opportunités repérées… ou tout simplement l'envie de faire évoluer votre situation.\\nParlez-nous de ce qui vous pousse à vouloir progresser : un déclic, une réflexion en cours, des difficultés rencontrées, des opportunités repérées… ou tout simplement l'envie de faire évoluer votre situation.\\n\"\n },\n \"user__sector_interest\": {\n \"title\": \"Pourquoi la formation vous intéresse-t-elle ?\",\n \"value\": \"Partagez-nous ce qui vous attire dans cette formation, vos objectifs à court terme (6 mois) et long terme (1–2 ans), et comment ces nouvelles compétences s'inscrivent dans votre évolution de carrière.\\nPartagez-nous ce qui vous attire dans cette formation, vos objectifs à court terme (6 mois) et long terme (1–2 ans), et comment ces nouvelles compétences s'inscrivent dans votre évolution de carrière.\\n\"\n },\n \"user__skills_level\": {\n \"title\": \"Quel est votre niveau actuel dans ce domaine ?\",\n \"value\": \"Quelques notions (autodidacte, lectures...)\"\n },\n \"user__skills_knowledge\": {\n \"title\": \"Que connaissez-vous déjà dans ce domaine et comment l'avez-vous appris ?\",\n \"value\": \"Partagez ce que vous avez déjà appris ou expérimenté : connaissances, formations suivies, lectures, projets réalisés (même petits), difficultés rencontrées ou lacunes que vous avez identifiées.\\nPartagez ce que vous avez déjà appris ou expérimenté : connaissances, formations suivies, lectures, projets réalisés (même petits), difficultés rencontrées ou lacunes que vous avez identifiées.\\n\"\n },\n \"user__career_goal\": {\n \"title\": \"Quel est votre objectif professionnel principal ?\",\n \"value\": \"Autre objectif\"\n },\n \"user__career_goal_details\": {\n \"title\": \"Précisez votre objectif principal\",\n \"value\": \"svsdvsvdfvsvsvsvsfvs\"\n },\n \"user__job_market\": {\n \"title\": \"Comment voyez-vous le marché du travail dans votre domaine cible ?\",\n \"value\": \"Plutôt porteur, opportunités régulières\"\n },\n \"user__network\": {\n \"title\": \"À quoi ressemble votre réseau et votre environnement professionnel ?\",\n \"value\": \"Parlez-nous de votre réseau : contacts dans ce domaine, soutien de votre employeur, accompagnement ou mentorat, et éventuelles communautés ou groupes professionnels auxquels vous participez.\\n\"\n },\n \"user__learning_challenge\": {\n \"title\": \"Quelle est votre principale difficulté quand vous apprenez quelque chose de nouveau ?\",\n \"value\": \"Partagez les obstacles que vous rencontrez en formation : manque de motivation, difficulté à mémoriser ou à comprendre, problèmes de confiance ou encore environnement peu favorable.\\n\"\n },\n \"user__learning_challenge_details\": {\n \"title\": \"Quels sont les obstacles auxquels vous faites face au quotidien ?\",\n \"value\": \"Parlez-nous des difficultés rencontrées : freins personnels (temps, motivation, confiance), obstacles extérieurs (financiers, familiaux, pro), peurs ou besoins d'accompagnement pour avancer.\\n\"\n },\n \"user_project__description\": {\n \"title\": \"Pouvez-vous nous expliquer votre projet comme si l'on ne connaissait rien à votre domaine ?\",\n \"value\": \"xpliquez clairement ce que vous proposez, à qui cela s'adresse, le problème que vous cherchez à résoudre, pourquoi il est important, et comment vous comptez concrètement mettre votre solution en placexpliquez clairement ce quefvdsfvssdvsvxdvzefececeeddvtez concrètement mettre votre solution en place\"\n },\n \"user_project__next_months\": {\n \"title\": \"Quelles sont vos 3 priorités pour les 3 prochains mois ?\",\n \"value\": \"Partagez-nous ce qui, à vos yeux, est le plus important pour avancer concrètement dans votre projet. Indiquez-nous ce que vous souhaitez apprendre, les résultats que vous voulez atteindre, les objectifs que vous aimeriez vous fixer.\\nPartagez-nous ce qui, à vos yeux, est le plus important pour avancer concrètement dans votre projet. Indiquez-nous ce que vous souhaitez apprendre, les résultats que vous voulez atteindre, les objectifs que vous aimeriez vous fixer.\\n\"\n },\n \"user_project__year_goals\": {\n \"title\": \"À quoi ressemble votre situation professionnelle idéale dans 1 an ?\",\n \"value\": \"Partagez nous ce que vous aimeriez attendre d'ici un an : résultats concrets, évolution de votre projet ou de votre posture, nouvelles compétences à acquérir, etc.k\\nPartagez nous ce que vous aimeriez\\n\"\n },\n \"user_project__website_url\": {\n \"title\": \"Site web\",\n \"value\": \"https://www.hellobank.fr/\"\n },\n \"user_project__facebook_page_url\": {\n \"title\": \"Page Facebook\",\n \"value\": null\n },\n \"user_project__instagram_url\": {\n \"title\": \"Profil Instagram\",\n \"value\": \"https://www.instagram.com/\"\n },\n \"user_project__linkedin_url\": {\n \"title\": \"Profil LinkedIn\",\n \"value\": \"https://\"\n },\n \"user_project__youtube_url\": {\n \"title\": \"Chaine Youtube\",\n \"value\": null\n },\n \"user_project__tiktok_url\": {\n \"title\": \"Profil Tiktok\",\n \"value\": null\n }\n }\n}"},{"id":"ae56f06c-f951-4e10-9ea2-9d0890c3bd36","name":"Show","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/users/me/project"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"goal\": \"boost_startup\",\n \"project_stage\": \"about_to_start\",\n \"business_sector\": \"engineering\",\n \"description\": \"My project is about spaceships\",\n \"next_months\": \"Send a rocket\",\n \"website_url\": \"https://www.nasa.gov\",\n \"facebook_page_url\": \"https://www.facebook.com/NASA/\",\n \"instagram_url\": \"https://www.instagram.com/nasa/\",\n \"parallel_activity\": \"Commercial\",\n \"time_spent\": \"5\"\n }\n}"}],"_postman_id":"36b12a0c-9ba1-4d2e-aba9-c37fd0ce5a09"},{"name":"Update a user project","id":"746e9790-2320-4575-92f2-2e38ed46b7ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"goal","value":"boost_startup","description":"

selected in a list of goals

\n","type":"text"},{"key":"project_stage","value":"about_to_start","description":"

selected in a list of project stages

\n","type":"text"},{"key":"business_sector","value":"engineering","description":"

selected in a list of business sectors

\n","type":"text"},{"key":"description","value":"A company that makes everything","description":"

text

\n","type":"text"},{"key":"next_months","value":"Start making one more thing","description":"

text

\n","type":"text"},{"key":"website_url","value":"https://www.example.com","description":"

URL

\n","type":"text"},{"key":"facebook_page_url","value":"https://www.facebook.com/nasa","description":"

URL

\n","type":"text"},{"key":"instagram_url","value":"https://www.instagram.com/nasa","description":"

URL

\n","type":"text"},{"key":"parallel_activity","value":"Train driver","description":"

text

\n","type":"text"},{"key":"time_spent","value":"15","description":"

can be \"5\" (less than 5 hours a week), \"10\" (5 to 10 hours a week) or \"15\" (more than 10 hours a week)

\n","type":"text"}]},"url":"https://api.livementor.com/v1/users/:id/project","description":"

Any set of attributes returned by the GET endpoint can be sent as form data or JSON payload.

Identifier of the user to retrieve info from, or \"me\"

\n","type":"text/plain"},"type":"any","value":"23560","key":"id"}]}},"response":[],"_postman_id":"746e9790-2320-4575-92f2-2e38ed46b7ac"}],"id":"328d1716-8ba2-4c29-bf88-69ebe6acab39","_postman_id":"328d1716-8ba2-4c29-bf88-69ebe6acab39","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Webinar View","item":[{"name":"Retrieve webinar views","id":"93fe5711-57e0-4f04-9c9e-9cf683d8251a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/webinar_views?webinars=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","webinar_views"],"host":["https://api.livementor.com"],"query":[{"description":{"content":"

(optional) a list of webinar ids used as a filter

\n","type":"text/plain"},"key":"webinars","value":""}],"variable":[]}},"response":[{"id":"533ba0c7-9f84-4c79-b34c-dcb54154c34c","name":"Index","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.livementor.com/v1/webinar_views?webinars=1317,708","host":["https://api.livementor.com"],"path":["v1","webinar_views"],"query":[{"key":"webinars","value":"1317,708","description":"(optional) a list of webinar ids used as a filter"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 288632,\n \"user_id\": 299095,\n \"webinar_id\": 1317,\n \"mode\": \"live\"\n },\n {\n \"id\": 288621,\n \"user_id\": 299095,\n \"webinar_id\": 708,\n \"mode\": \"replay\"\n }\n ],\n \"total_items\": 2,\n \"pagination\": {\n \"current_page\": \"/v1/webinar_views?webinars=1317%2C708&page=1\",\n \"first_page\": \"/v1/webinar_views?webinars=1317%2C708&page=1\",\n \"last_page\": \"/v1/webinar_views?webinars=1317%2C708&page=1\",\n \"next_page\": null,\n \"prev_page\": null\n }\n}"}],"_postman_id":"93fe5711-57e0-4f04-9c9e-9cf683d8251a"},{"name":"Create a webinar view","id":"52be12b6-10dd-4b37-b762-ff9ae201c29f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"webinar_id","value":"1234","description":"

the identifier of the webinar

\n","type":"text"},{"key":"mode","value":"live","description":"

can be \"live\" or \"replay\"

\n","type":"text"}]},"url":"https://api.livementor.com/v1/webinar_views","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","webinar_views"],"host":["https://api.livementor.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"52be12b6-10dd-4b37-b762-ff9ae201c29f"}],"id":"776ac7ee-e001-44d0-b414-fefa39ed721f","description":"

Webinar views represent the fact that a user has viewed a webinar.

A webinar view contains the following informations:

a webinar_id,
a user_id,
a mode: whether the webinar was viewed \"live\" or as a \"replay\".

\n","_postman_id":"776ac7ee-e001-44d0-b414-fefa39ed721f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}},{"name":"Webinars","item":[{"name":"Retrieve a webinar","id":"2df85f4f-c26a-428f-b086-e35203156bba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/webinars/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}},"urlObject":{"path":["v1","webinars",":id"],"host":["https://api.livementor.com"],"query":[],"variable":[{"description":{"content":"

the identifier of the webinar

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"7cc120f5-62d9-4e9c-8fc5-fe24444d8795","name":"Index","originalRequest":{"method":"GET","header":[],"url":"https://api.livementor.com/v1/webinars/978"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 978,\n \"title\": \"Et si l'échec était positif ?\",\n \"description\": \"

Dans chaque échec se cache un apprentissage. Dans ce webinaire, nous allons tous ensemble, nous interroger sur les questions suivantes : comment rebondir suite à un échec professionnel ou entrepreneurial ? Comment expliquer la situation et communiquer à son entourage, à ses clients ? Quelles sont les clés pour oser se réinventer ?

\",\n \"category\": \"qa\",\n \"start_date\": \"2021-01-15T12:00:00.000Z\",\n \"duration\": 60,\n \"nb_slots\": 250,\n \"enrollment_count\": 14,\n \"replay_url\": \"https://player.vimeo.com/video/\",\n \"picture\": \"/system/webinars/pictures/000/000/978/original/_.png?1610619417\",\n \"background_picture\": \"/system/webinars/background_pictures/000/000/978/original/_bg_.jpg?1610619417\",\n \"draft\": false,\n \"host_mentor\": {\n \"id\": 9999,\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"picture\": \"\"\n },\n \"addevent_url\": \"\"\n }\n}"}],"_postman_id":"2df85f4f-c26a-428f-b086-e35203156bba"}],"id":"ca9eae8b-c871-478c-9b67-4b10dab6c4d0","description":"

Webinars are collective activities where a mentor hosts a video session with entrepreneurs. Entrepreneurs can either enroll for the webinar and watch it live, or watch its replay later.

A webinar contains the following informations:

id
title
description
category: can be \"qa\", \"guest\" or \"lesson\"
start_date
duration
nb_slots: the maximum amount of entrepreneurs that can enroll in this webinar.
enrollment_count: the current amount of entrepreneurs that have enrolled in this webinar.
replay_url: after the webinar has ended, the URL to the replay video for this webinar.
picture: a preview picture for this webinar.
background_picture: a background picture for this webinar.
draft: true if the webinar is not yet published. Only mentors can access draft webinars.
host_mentor: an object contaning the id, given_name, family_name and picture of the host mentor.
addevent_url: an URL to add this webinar to a calendar via Addevent.
zoom_mentor_url: the URL to start the live webinar (only for the host mentor).

\n","_postman_id":"ca9eae8b-c871-478c-9b67-4b10dab6c4d0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","id":"f3f31499-a7f0-4701-9dd3-fd84685e71f7","name":"API LiveMentor","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{LIVEMENTOR_AUTH_TOKEN}}"}]}},"event":[{"listen":"prerequest","script":{"id":"cce78d63-ba57-4fdd-8483-4df049ee6e1a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e27f4ea1-714b-4d3f-b37a-e8de67a4dc35","type":"text/javascript","exec":[""]}}],"variable":[{"key":"BASE_URL","value":"https://api.livementor.com"}]}

Authentication

Token generation

Token usage

Token revocation

Responses & errors

Successful calls

Error messages

Pagination

Request IDs

Versionning

${data.title}