This method returns a list of lessons within your organization.


Parameters

Your request data may contain the following parameters. GET or POST the object (as JSON) to https://api.iscout.com/v1/lessons.list.

Parameter Example Required Description
token "YOUR_TOKEN" Required Your API Token
pretty true Optional true means the response json will include white space for readability. Default is false.

Example Request


Example Response

{
  "ok": true,
  "lessons": [
    {
      "id": 1025,
      "created": 1476718839577,
      "updated": 1476718839577,
      "title": "Acme Orientation",
      "description_html": "

In this employee orientation, you will watch a video and then take a quiz on basic procedures related to the operations of Acme.

Upon successful completion of the course, students will receive a 2 year digital certificate.

Topics include:

  • Online Resources and Tools
  • Orientation Proceedures
  • Role of Human Resources
  • New Employee Responsibilities
", "modules": [ { "title": "A Note From HR", "type": "text", "minimum_seconds": 10 }, { "title": "Welcome to Acme", "type": "youtube", "minimum_seconds": 10 }, { "title": "Employee Handbook", "type": "document", "minimum_seconds": 10 }, { "title": "Quiz", "type": "quiz" } ] }, { "id": 1026, "created": 1476718839579, "updated": 1476718839579, "title": "Ladder Safety", "description_html": "

In this training session, you will learn the fundamental principles of Acme ladder safety.

Upon successful completion of the course, students will receive a one year digital certificate of completion.

Topics include:

  • Ladder Types
  • Before You Climb
  • Spotters
  • Ladder Transportation
", "modules": [ { "title": "Note From HSE", "type": "text", "minimum_seconds": 0 }, { "title": "Training Video", "type": "youtube", "minimum_seconds": 0 }, { "title": "Employee Handbook", "type": "document", "minimum_seconds": 0 }, { "title": "Quiz", "type": "quiz" } ] } ] }

Errors

If an error occurs, the response JSON will have ok set to false:

{
  "ok": false,
  "error": "token_invalid",
  "description": "The token `YOUR_TOKEN` was not found."
}

The error field will contain one of the following error identifiers and there may also be a description field with a more detailed explanation:

Identifier Description
api_method_not_found The requested url did not match any iScout api method.
request_method_invalid The requested method was not GET or POST.
request_data_invalid The request did not include a valid JSON request object.
rate_limit_exceeded This token is exceeding its request limit.
token_missing The request did not include a token.
token_invalid The request token was invalid.
token_inactive The request token was has been deactivated.
token_permission The request token does not have write permission.
account_inactive The request token was for an account that is not active.
parameter_unexpected The request data included a parameter that is not supported.
parameter_missing The request data failed to include a parameter which was required.
parameter_invalid The request data included a parameter which had a value that is not allowed.
server_error The server encountered an internal error.
content_not_found The requested content was not found.