API Documentation

Introduction. With Miestro API you can now integrate your Miestro Account with your external apps, websites, SSO or services.. API Version. API Version - v1.0 Published on Dec 3th 2020. Authentication. For Authentication purposes, your Api Key and Api Secret needs to be set in the header of all API calls. The header keys that need to be set are given below:. X-Forward-Api-KeyX-Forward-Api-SecretData Format. Will be in JSON format.. Authentication Errors. Error a user can expect on invalid authentication.. Invalid Api Key or Api Secret credentialsPagination. You will receive upto a max 15 items on your responses by default. However, you can increase the limit using the "count" param in your request.. Users. . . GET. Get Users list. . https://api.miestro.com/api/v1.0/users?query[]=search=&query[]=role=&sortBy=created_at:asc&count=15&page=1. . . Role. . 0 => User1 => Owner2 => Admin3 => Assistant4 => Support Specialist. . . Params. . count. The number of items to be returned. Default: 15 , Type: Number. . . page. The page within the collection to fetch.Default: 1. . . sortBy. Any users table field like name or email. Default created_at DESC. . . role. integer. . . search. Get list with search keyword. Searches for name or email. . . . Example response. . { "current_page": 1, "data": [ { "id": 1, "name": "example", "email": "example@mail.com", "picture_src": null, "company_name": null, "role": 0, "paypal_email": null, "email_unsubscribe": 0, "version": 1, "next_billing_date": null, "score": 0, "last_login_at": null, "created_at": "2020-11-24 07:39:46", "picture_full_src": "https://miestro.com/images/account/user.png", "stripe_customer_id": null } ], "first_page_url": "https://api.miestro.com/api/v1.0/users?page=1", "from": 1, "last_page": 36, "last_page_url": "https://api.miestro.com/api/v1.0/users?page=36", "next_page_url": "https://api.miestro.com/api/v1.0/users?page=2", "path": "https://api.miestro.com/api/v1.0/users", "per_page": "1", "prev_page_url": null, "to": 1, "total": 36 }. . POST. Add User. . https://api.miestro.com/api/v1.0/users. Response – Returns user json on success.. . ATTRIBUTES. . name. Example Name. . . email. info@example.com. . . password. 123456. . . role. 0. . . . Example response. . { "id": 1, "name": "Example Name", "email": "info@example.com", "picture_src": null, "company_name": null, "role": 0, "paypal_email": null, "email_unsubscribe": 0, "version": 1, "next_billing_date": null, "score": 0, "last_login_at": null, "created_at": "2020-11-24 07:39:46", "picture_full_src": "https://miestro.com/images/account/user.png", "stripe_customer_id": null }. . PUT. Update User. . https://api.miestro.com/api/v1.0/users/{user_id}. . ATTRIBUTES. . . . name. Example Name. . . email. info@example.com. . . password. 123456. . . role. 0. . . . Example response. . {}. . GET. Get User Details. . https://api.miestro.com/api/v1.0/users/{user_id}. Response – User Details on success.. . Example response. . { "id": 1, "name": "Example Name", "email": "info@example.com", "picture_src": null, "company_name": null, "role": 0, "paypal_email": null, "email_unsubscribe": 0, "version": 1, "next_billing_date": null, "score": 0, "last_login_at": null, "created_at": "2020-11-24 07:39:46", "picture_full_src": "https://miestro.com/images/account/user.png", "stripe_customer_id": null }. . DEL. Delete a User. . https://api.miestro.com/api/v1.0/users/{user_id}. Response – User Details on success.. . Example response. . {}. . POST. Enroll User to a Course. . https://api.miestro.com/api/v1.0/users/{user_id}/enroll. . ATTRIBUTES. . course_id. Number. . . . Example response. . {}. . POST. Unroll User to a Course. . https://api.miestro.com/api/v1.0/users/{user_id}/unroll. . ATTRIBUTES. . course_id. Number. . . . Example response. . {}. . Courses. . . GET. Get List of Courses. . https://api.miestro.com/api/v1.0/courses?query[]=search=&query[]=status=&sortBy=created_at:asc&count=15&page=1. . Params. . count. The number of items to be returned. Default: 15 , Type: Number. . . page. The page within the collection to fetch.Default: 1. . . sortBy. Any users table field like name. Default created_at DESC. . . status. 1 - Published. 2 - unpublised Default: All. . . search. Get list with search keyword. Searches for name. . . . Example response. . { "current_page": 1, "data": [ { "id": 1, "name": "Example", "subtitle": null, "is_published": 2, "show_course": 1, "description": "Default Course Description", "picture_src": "https://miestro.com/images/defaults/thumbnail.png", "thumbnail_image": "https://miestro.com/images/defaults/thumbnail.png", "logo": "https://miestro.com/images/defaults/course-logo.png", "url": "example", "landing_url": "landing-1598523316e8al71VDZv-13", "landing_custom_url": null, "is_custom_url": 0, "bio_description": null, "seo_title": null, "seo_description": null, "seo_keywords": null, "finish_message": null, "thank_you_page": 1, "thank_you_page_url": "https://miestro.com/asd", "thank_you_title": null, "thank_you_message": null, "thank_you_title_show": 0, "thank_you_message_show": 0, "thank_you_button_text_color": "#fff", "thank_you_button_bg_color": "#3f4f65", "thank_you_button_text": "Continue", "thank_you_button_font_size": null, "is_rated_on": 1, "rated_ids": [ "62", "63" ], "created_at": "2020-08-27 10:15:16" } ], "first_page_url": "https://api.miestro.com/api/v1.0/courses?page=1", "from": 1, "last_page": 2, "last_page_url": "https://api.miestro.com/api/v1.0/courses?page=2", "next_page_url": "https://api.miestro.com/api/v1.0/courses?page=2", "path": "https://api.miestro.com/api/v1.0/courses", "per_page": "1", "prev_page_url": null, "to": 1, "total": 2 }. . GET. Get a Specific Course. . https://api.miestro.com/api/v1.0/courses/{course_id}. Response – Course details on success. . Example response. . { "id": 1, "name": "Example", "subtitle": null, "is_published": 2, "show_course": 1, "description": "Default Course Description", "picture_src": "https://miestro.com/images/defaults/thumbnail.png", "thumbnail_image": "https://miestro.com/images/defaults/thumbnail.png", "logo": "https://miestro.com/images/defaults/course-logo.png", "url": "example", "landing_url": "landing-1598523316e8al71VDZv-13", "landing_custom_url": null, "is_custom_url": 0, "bio_description": null, "seo_title": null, "seo_description": null, "seo_keywords": null, "finish_message": null, "thank_you_page": 1, "thank_you_page_url": "https://miestro.com/asd", "thank_you_title": null, "thank_you_message": null, "thank_you_title_show": 0, "thank_you_message_show": 0, "thank_you_button_text_color": "#fff", "thank_you_button_bg_color": "#3f4f65", "thank_you_button_text": "Continue", "thank_you_button_font_size": null, "is_rated_on": 1, "rated_ids": [ "62", "63" ], "created_at": "2020-08-27 10:15:16" }. . POST. Enroll User to a Course. . https://api.miestro.com/api/v1.0/courses/{course_id}/enroll. . ATTRIBUTES. . user_id. Number. . . . Example response. . {}.

Still puzzling over something?