Skip to content
Honen Academy

explore

List Explore sections + the master toggle state.

List Explore sections + the master toggle state.

OpenAPI specification
POST/api/v1/explore/sections-list

Authentication

bearerAuth

Request

curl --globoff --request POST \
  --url 'https://honen.com/api/v1/explore/sections-list' \
  --header 'Authorization: Bearer <BEARER_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data-raw '{}'

Replace credential and <field> placeholders with your own values. URL placeholders appear as %3Cfield%3E. Review the example values before sending your request.

Use the sample JSON body as your starting point, and enter values that match the endpoint's schema.

Request body schema or example

{
  "type": "object",
  "properties": {}
}

Responses

200Command result.
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "data": {
      "type": "object",
      "properties": {
        "exploreEnabled": {
          "type": "boolean",
          "enum": [
            false,
            true
          ]
        },
        "exploreOnHome": {
          "type": "boolean",
          "enum": [
            false,
            true
          ]
        },
        "sections": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "slug": {
                "type": "string"
              },
              "title": {
                "type": "string"
              },
              "subtitle": {
                "type": "string",
                "nullable": true
              },
              "tag": {
                "type": "string",
                "nullable": true
              },
              "description": {
                "type": "string",
                "nullable": true
              },
              "color": {
                "type": "string",
                "nullable": true
              },
              "layout": {
                "type": "string"
              },
              "position": {
                "type": "number"
              },
              "isActive": {
                "type": "boolean",
                "enum": [
                  false,
                  true
                ]
              },
              "courseIds": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "courses": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "title": {
                      "type": "string"
                    },
                    "coverImage": {
                      "type": "string"
                    },
                    "isPublished": {
                      "type": "boolean",
                      "enum": [
                        false,
                        true
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "title",
                    "isPublished"
                  ]
                }
              },
              "source": {
                "type": "string",
                "enum": [
                  "MANUAL",
                  "CURRICULUM",
                  "CATALOG"
                ]
              },
              "catalogId": {
                "type": "string",
                "nullable": true
              },
              "curriculumId": {
                "type": "string",
                "nullable": true
              },
              "curriculumTitle": {
                "type": "string",
                "nullable": true
              },
              "visibleToGroupIds": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "hiddenFromGroupIds": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "updatedAt": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "slug",
              "title",
              "subtitle",
              "tag",
              "description",
              "color",
              "layout",
              "position",
              "isActive",
              "courseIds",
              "courses",
              "source",
              "catalogId",
              "curriculumId",
              "curriculumTitle",
              "visibleToGroupIds",
              "hiddenFromGroupIds",
              "updatedAt"
            ]
          }
        },
        "totalCount": {
          "type": "number"
        }
      },
      "required": [
        "exploreEnabled",
        "exploreOnHome",
        "sections",
        "totalCount"
      ]
    }
  },
  "required": [
    "success",
    "data"
  ]
}
400Malformed JSON request body.
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "resolution": {
          "type": "string"
        },
        "errors": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "details": {
          "nullable": true
        }
      },
      "required": [
        "code",
        "message",
        "resolution"
      ]
    }
  },
  "required": [
    "success",
    "error"
  ]
}
401Missing or invalid Connector credentials.
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "resolution": {
          "type": "string"
        },
        "errors": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "details": {
          "nullable": true
        }
      },
      "required": [
        "code",
        "message",
        "resolution"
      ]
    }
  },
  "required": [
    "success",
    "error"
  ]
}
403Connector policy does not permit this command.
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "resolution": {
          "type": "string"
        },
        "errors": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "details": {
          "nullable": true
        }
      },
      "required": [
        "code",
        "message",
        "resolution"
      ]
    }
  },
  "required": [
    "success",
    "error"
  ]
}
404Unknown command.
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "resolution": {
          "type": "string"
        },
        "errors": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "details": {
          "nullable": true
        }
      },
      "required": [
        "code",
        "message",
        "resolution"
      ]
    }
  },
  "required": [
    "success",
    "error"
  ]
}
422Input validation error.
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "enum": [
        false
      ]
    },
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "resolution": {
          "type": "string"
        },
        "errors": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "details": {
          "nullable": true
        }
      },
      "required": [
        "code",
        "message",
        "resolution"
      ]
    }
  },
  "required": [
    "success",
    "error"
  ]
}