Elements

List all activites

GET

https://api.teachfloor.com

/v0/elements/{id}/activities

Returns a list of activites related to the element.

If the activity is performed by an individual, the member key contains the details of the member who completed the activity.
If the activity is performed by a group, the members key provides a list of all members who participated in the activity.

List all activites › path Parameters

id

string · required

The ID of the element to retrieve an activities.

List all activites › query Parameters

member

string

The unique ID of the member to filter activities for.

Example: 6K8vojJn1xe14abL

List all activites › Headers

Authorization

string

Content-Type

string

Accept

string

List all activites › Responses

200

GET/v0/elements/{id}/activities

curl --request GET \
  --url https://api.teachfloor.com/v0/elements/:id/activities

shell

Example Responses

{
  "error": null,
  "payload": {
    "data": [
      {
        "id": "KwJ8VgrmlAp4PBnM",
        "object": "activity",
        "timestamp": "2022-11-27T13:52:02.000000Z",
        "status": "PASSED",
        "passed": true,
        "score": 100,
        "completed_by": "6K8vojJn1xe14abL",
        "member": {
          "id": "6K8vojJn1xe14abL",
          "object": "member",
          "first_name": "Adalberto",
          "last_name": "Bruen",
          "full_name": "Adalberto Bruen",
          "avatar": null,
          "email": "iva52@example.org",
          "is_email_verified": true,
          "last_seen": "2024-11-27T13:51:52.000000Z"
        },
        "context": {
          "id": "QB8nmEJjqdbLA2K5",
          "object": "element",
          "created_at": "2024-11-26T11:37:16.000000Z",
          "name": "Multiple Choice Quiz",
          "cover": null,
          "type": "QUIZ",
          "content": null,
          "position": 3,
          "course": "B4peAvmZ1L9OY3Xr",
          "module": "no0aApWNyRMD68rv",
          "metadata": {},
          "properties": {
            "passing_score": 70,
            "completion_trigger": "on_pass"
          }
        }
      },
      "{...}",
      "{...}"
    ],
    "pagination": {
      "total": 3,
      "count": 3,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

json

application/json

List all Elements

GET

https://api.teachfloor.com

/v0/elements

Returns a list of elements within your organization. The elements are sorted by their creation date, with the most recently created elements appearing first.

List all Elements › query Parameters

page

integer

A cursor for pagination across multiple pages of results.

Example: 2

List all Elements › Headers

Authorization

string

Content-Type

string

Accept

string

List all Elements › Responses

200

Create element

POST

https://api.teachfloor.com

/v0/elements

Creates an element in the specified module. Returns the created element details upon successful creation.

Create element › Headers

Authorization

string

Content-Type

string

Accept

string

Create element › Request Body

module

string · required

The module id of the element.

Example: no0aApWNyRMD68rv

name

string

The element name. Must not be greater than 255 characters.

Example: First knowledge

content

string

The element content in markdown format. Supports headings, bold, italic, strikethrough, highlights, inline code, code blocks, blockquotes, lists, tables, images, links, and math (LaTeX).

Example: # Element Introduction\nWelcome to the **first element**.

position

integer

The 0-indexed position of the element within its module. If omitted, the element is appended at the end. Values beyond the last sibling index are clamped to the last position. Siblings are re-ordered automatically. Must be at least 0.

Example: 0

type

string

The element type. Must be one of: CONTENT, VIDEO, ZOOM_MEETING, MEETING_LINK, QUIZ, SUBMISSION, GROUP_SUBMISSION, EMBED, SURVEY, SCORM, CERTIFICATE, TAG, DATACAMP, SELF_REVIEW, PEER_REVIEW, FEEDBACK_REFLECTION, INSTRUCTOR_REVIEW, INSTRUCTOR_DISCUSSION, AI_REVIEW, CHECKLIST, DISCUSSION, FILE, GROUP_FORMATION, FORM, SCORE, GROUP_PEER_REVIEW, GROUP_FEEDBACK_REFLECTION, MICROSOFT_TEAMS_MEETING.

Example: QUIZ

metadata

string

Metadata is an attribute that lets you store more information, structured as key-value pairs, for your own use and reference.
You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Keys and values are stored as strings and can contain any characters with one exception: you can't use square brackets ([ and ]) in keys.

Example: {"category":"marketing"}

properties

string

Type-specific properties for the element. The accepted keys depend on the element type. Unknown keys will be rejected with a validation error.

Supported element types and their properties:

VIDEO
  • video_url (string) — The video URL. Supports Vimeo, YouTube, and direct video URLs.
  • video_type (string) — The video source type. Must be set to URL when updating the video_url. Must be one of: URL, SOURCE.

QUIZ
  • passing_score (integer) — The minimum passing score (0-100).
  • completion_trigger (string) — When the quiz should be marked as complete. Must be one of: on_pass, on_submit.
  • questions (array) — The quiz questions. Full replacement — the entire questions array is replaced on update. Include existing question/answer IDs to preserve links to student responses. Omit IDs to auto-generate new ones.

Questions
The questions property accepts an array of question objects. The entire questions array is replaced on every update (full replacement, not merge).

Important — Question and Answer IDs:
Each question and answer has an id field. These IDs link to student responses, activity records, and grades. When updating questions:
  • Include the id to preserve an existing question/answer and maintain links to student data.
  • Omit the id to create a new question/answer with an auto-generated ID.
  • Questions/answers not included in the array will be removed.
  • If you change or omit an existing ID, the link to student responses for that question/answer will be broken.

Question object:
  • id (string, optional) — Existing question ID to preserve. Omit for new questions.
  • text (string, required) — The question text.
  • shuffle (boolean, optional) — Whether to shuffle answer order. Default: false.
  • require_all_correct (boolean, optional) — Require all correct answers selected (multi-choice). Default: false.
  • answers (array, required) — Array of answer objects.

Answer object:
  • id (string, optional) — Existing answer ID to preserve. Omit for new answers.
  • text (string, required) — The answer text.
  • is_correct (boolean, required) — Whether this is a correct answer.

EMBED
  • embed (string) — The embed code.

FILE
  • file_url (string) — The file URL.

SUBMISSION
  • questions (array) — The submission questions. Full replacement on update. Each question defines which response types (text, file) are accepted.

Questions
The questions property accepts an array of question objects. The entire questions array is replaced on every update (full replacement, not merge). Each question defines which response types (text, file) are accepted.

Question object:
  • id (string, optional) — Existing question ID to preserve. Omit for new questions.
  • text (string, required) — The question text.
  • accept_text (boolean, optional) — Whether text responses are accepted. Default: true.
  • text_required (boolean, optional) — Whether text response is required. Default: false.
  • accept_file (boolean, optional) — Whether file uploads are accepted. Default: false.
  • file_required (boolean, optional) — Whether file upload is required. Default: false.
  • file_multiple (boolean, optional) — Whether multiple files can be uploaded. Default: false.

GROUP_SUBMISSION
  • questions (array) — The submission questions. Full replacement on update. Each question defines which response types (text, file) are accepted.

Questions
The questions property accepts an array of question objects. The entire questions array is replaced on every update (full replacement, not merge). Each question defines which response types (text, file) are accepted.

Question object:
  • id (string, optional) — Existing question ID to preserve. Omit for new questions.
  • text (string, required) — The question text.
  • accept_text (boolean, optional) — Whether text responses are accepted. Default: true.
  • text_required (boolean, optional) — Whether text response is required. Default: false.
  • accept_file (boolean, optional) — Whether file uploads are accepted. Default: false.
  • file_required (boolean, optional) — Whether file upload is required. Default: false.
  • file_multiple (boolean, optional) — Whether multiple files can be uploaded. Default: false.

SURVEY
  • questions (array) — The survey questions. Full replacement on update. Each question has a text and a list of options participants can choose from.

Questions
The questions property accepts an array of survey (poll-style) questions. The entire questions array is replaced on every update (full replacement, not merge). Each question has a text and a list of answer options participants can choose from. There are no correct answers and no scoring.

Question object:
  • id (string, optional) — Existing question ID to preserve. Omit for new questions.
  • text (string, required) — The question text.
  • options (array, required) — Answer options (at least 2).

Option object:
  • id (string, optional) — Existing option ID to preserve.
  • text (string, required) — The option text.

FORM
  • questions (array) — The form questions. Full replacement — the entire questions array is replaced on update. Each question has a type that determines its structure.

Questions
The questions property accepts an array of question objects. The entire questions array is replaced on every update (full replacement, not merge). Each question has a type that determines its structure.

Question types: TEXT, NUMBER_SCALE, MULTIPLE_CHOICE, STACK_RANK, INFO_BOX

Common fields (all types):
  • id (string, optional) — Existing question ID to preserve. Omit for new questions.
  • type (string, required) — The question type.
  • text (string, required) — The question text.
  • optional (boolean, optional) — Whether the question is optional. Default: false.

TEXT type additional fields:
  • min_words (integer, optional) — Minimum word count. Default: 1.

NUMBER_SCALE type additional fields:
  • range_min (integer, optional) — Scale minimum value. Default: 1.
  • range_max (integer, optional) — Scale maximum value. Default: 10.

MULTIPLE_CHOICE / STACK_RANK type additional fields:
  • options (array, required) — Array of option objects.

Option object:
  • id (string, optional) — Existing option ID to preserve.
  • text (string, required) — The option text.

MEETING_LINK
  • meeting_url (string) — The meeting URL.
  • start_date (string) — The meeting start date (ISO 8601 format).
  • end_date (string) — The meeting end date (ISO 8601 format).

ZOOM_MEETING
  • start_date (string) — The meeting start date (ISO 8601 format).
  • end_date (string) — The meeting end date (ISO 8601 format).
  • meeting_reports (boolean) — Whether attendance tracking is enabled.

MICROSOFT_TEAMS_MEETING
  • start_date (string) — The meeting start date (ISO 8601 format).
  • end_date (string) — The meeting end date (ISO 8601 format).
  • meeting_reports (boolean) — Whether attendance tracking is enabled.

SCORM
  • scorm_url (string) — The URL of the uploaded SCORM package file. Read-only.
  • scorm_user_identifier (string) — The identifier used to track learners. Must be one of: user_id, user_email.

CHECKLIST
  • questions (array) — The checklist items. Full replacement on update. Each item is a simple { id?, text } object.

Questions
The questions property accepts an array of checklist items. The entire items array is replaced on every update (full replacement, not merge). Each item is a simple object with a text field.

Item object:
  • id (string, optional) — Existing item ID to preserve. Omit for new items.
  • text (string, required) — The checklist item text.

PEER_REVIEW
  • source (object) — The submission element being reviewed. On read returns { type, id, name }. On write pass { id: "element_id" } or null to clear.
  • questions (array) — The review rubric questions. Full replacement on update. Types: TEXT, TEXT_SCALE, NUMBER_SCALE, YES_NO, INFO_BOX.

Source
The source property references the submission element being reviewed. On read it returns an object with type, id, and name. On write, pass { "id": "element_id" }, or null to clear. The referenced element must be of type SUBMISSION and must belong to the same course.

Questions
The questions property accepts an array of review rubric question objects. The entire questions array is replaced on every update (full replacement, not merge). Each question has a type that determines its structure.

Question types: TEXT, TEXT_SCALE, NUMBER_SCALE, YES_NO, INFO_BOX

Common fields (all types):
  • id (string, optional) — Existing question ID to preserve.
  • type (string, required) — The question type.
  • text (string, required) — The question text.
  • optional (boolean, optional) — Whether the question is optional. Default: false.

TEXT: min_words (integer)
NUMBER_SCALE: range_min (integer), range_max (integer)
TEXT_SCALE: options (array of { text }) — ordered from lowest to highest score.
YES_NO: yes_text (string), no_text (string)
INFO_BOX: no additional fields

SELF_REVIEW
  • source (object) — The submission element being self-reviewed. On read returns { type, id, name }. On write pass { id: "element_id" } or null to clear. Must be a SUBMISSION element in the same course.
  • questions (array) — The review rubric questions. Full replacement on update. Types: TEXT, TEXT_SCALE, NUMBER_SCALE, YES_NO, INFO_BOX.

Source
The source property references the submission element being reviewed. On read it returns an object with type, id, and name. On write, pass { "id": "element_id" }, or null to clear. The referenced element must be of type SUBMISSION and must belong to the same course.

Questions
The questions property accepts an array of review rubric question objects. The entire questions array is replaced on every update (full replacement, not merge). Each question has a type that determines its structure.

Question types: TEXT, TEXT_SCALE, NUMBER_SCALE, YES_NO, INFO_BOX

Common fields (all types):
  • id (string, optional) — Existing question ID to preserve.
  • type (string, required) — The question type.
  • text (string, required) — The question text.
  • optional (boolean, optional) — Whether the question is optional. Default: false.

TEXT: min_words (integer)
NUMBER_SCALE: range_min (integer), range_max (integer)
TEXT_SCALE: options (array of { text }) — ordered from lowest to highest score.
YES_NO: yes_text (string), no_text (string)
INFO_BOX: no additional fields

INSTRUCTOR_REVIEW
  • source (object) — The submission element being reviewed. On read returns { type, id, name }. On write pass { id: "element_id" } or null to clear. Must be a SUBMISSION or GROUP_SUBMISSION element in the same course.
  • questions (array) — The review rubric questions. Full replacement on update. Types: TEXT, TEXT_SCALE, NUMBER_SCALE, YES_NO, INFO_BOX.

Source
The source property references the submission element being reviewed. On read it returns an object with type, id, and name. On write, pass { "id": "element_id" }, or null to clear. The referenced element must be of type SUBMISSION or GROUP_SUBMISSION and must belong to the same course.

Questions
The questions property accepts an array of review rubric question objects. The entire questions array is replaced on every update (full replacement, not merge). Each question has a type that determines its structure.

Question types: TEXT, TEXT_SCALE, NUMBER_SCALE, YES_NO, INFO_BOX

Common fields (all types):
  • id (string, optional) — Existing question ID to preserve.
  • type (string, required) — The question type.
  • text (string, required) — The question text.
  • optional (boolean, optional) — Whether the question is optional. Default: false.

TEXT: min_words (integer)
NUMBER_SCALE: range_min (integer), range_max (integer)
TEXT_SCALE: options (array of { text }) — ordered from lowest to highest score.
YES_NO: yes_text (string), no_text (string)
INFO_BOX: no additional fields

INSTRUCTOR_DISCUSSION
  • source (object) — The submission element being discussed. On read returns { type, id, name }. On write pass { id: "element_id" } or null to clear. Must be a SUBMISSION or GROUP_SUBMISSION element in the same course.

Source
The source property references the submission element being discussed. On read it returns an object with type, id, and name. On write, pass { "id": "element_id" }, or null to clear. The referenced element must be of type SUBMISSION or GROUP_SUBMISSION and must belong to the same course.

AI_REVIEW
  • source (object) — The submission element being reviewed. On read returns { type, id, name }. On write pass { id: "element_id" } or null to clear. Must be a SUBMISSION element in the same course.
  • questions (array) — The review rubric questions. Full replacement on update. Types: TEXT, TEXT_SCALE, NUMBER_SCALE, YES_NO, INFO_BOX.

Source
The source property references the submission element being reviewed. On read it returns an object with type, id, and name. On write, pass { "id": "element_id" }, or null to clear. The referenced element must be of type SUBMISSION and must belong to the same course.

Questions
The questions property accepts an array of review rubric question objects. The entire questions array is replaced on every update (full replacement, not merge). Each question has a type that determines its structure.

Question types: TEXT, TEXT_SCALE, NUMBER_SCALE, YES_NO, INFO_BOX

Common fields (all types):
  • id (string, optional) — Existing question ID to preserve.
  • type (string, required) — The question type.
  • text (string, required) — The question text.
  • optional (boolean, optional) — Whether the question is optional. Default: false.

TEXT: min_words (integer)
NUMBER_SCALE: range_min (integer), range_max (integer)
TEXT_SCALE: options (array of { text }) — ordered from lowest to highest score.
YES_NO: yes_text (string), no_text (string)
INFO_BOX: no additional fields

FEEDBACK_REFLECTION
  • source (object) — The peer review element this reflection is linked to. On read returns { type, id, name }. On write pass { id: "element_id" } or null to clear. Must be a PEER_REVIEW element in the same course.
  • questions (array) — The reflection questions. Full replacement on update. Types: TEXT, TEXT_SCALE, NUMBER_SCALE, YES_NO, INFO_BOX.

Source
The source property references the peer review element this reflection is linked to. On read it returns an object with type, id, and name. On write, pass { "id": "element_id" }, or null to clear. The referenced element must be of type PEER_REVIEW and must belong to the same course.

Questions
The questions property accepts an array of reflection question objects. The entire questions array is replaced on every update (full replacement, not merge). Each question has a type that determines its structure.

Question types: TEXT, TEXT_SCALE, NUMBER_SCALE, YES_NO, INFO_BOX

Common fields (all types):
  • id (string, optional) — Existing question ID to preserve.
  • type (string, required) — The question type.
  • text (string, required) — The question text.
  • optional (boolean, optional) — Whether the question is optional. Default: false.

TEXT: min_words (integer)
NUMBER_SCALE: range_min (integer), range_max (integer)
TEXT_SCALE: options (array of { text }) — ordered from lowest to highest score.
YES_NO: yes_text (string), no_text (string)
INFO_BOX: no additional fields

GROUP_PEER_REVIEW
  • source (object) — The group submission element being reviewed. On read returns { type, id, name }. On write pass { id: "element_id" } or null to clear.
  • questions (array) — The review rubric questions. Full replacement on update. Types: TEXT, TEXT_SCALE, NUMBER_SCALE, YES_NO, INFO_BOX.

Source
The source property references the submission element being reviewed. On read it returns an object with type, id, and name. On write, pass { "id": "element_id" }, or null to clear. The referenced element must be of type GROUP_SUBMISSION and must belong to the same course.

Questions
The questions property accepts an array of review rubric question objects. The entire questions array is replaced on every update (full replacement, not merge). Each question has a type that determines its structure.

Question types: TEXT, TEXT_SCALE, NUMBER_SCALE, YES_NO, INFO_BOX

Common fields (all types):
  • id (string, optional) — Existing question ID to preserve.
  • type (string, required) — The question type.
  • text (string, required) — The question text.
  • optional (boolean, optional) — Whether the question is optional. Default: false.

TEXT: min_words (integer)
NUMBER_SCALE: range_min (integer), range_max (integer)
TEXT_SCALE: options (array of { text }) — ordered from lowest to highest score.
YES_NO: yes_text (string), no_text (string)
INFO_BOX: no additional fields

GROUP_FEEDBACK_REFLECTION
  • source (object) — The group peer review element this reflection is linked to. On read returns { type, id, name }. On write pass { id: "element_id" } or null to clear. Must be a GROUP_PEER_REVIEW element in the same course.
  • questions (array) — The reflection questions. Full replacement on update. Types: TEXT, TEXT_SCALE, NUMBER_SCALE, YES_NO, INFO_BOX.

Source
The source property references the peer review element this reflection is linked to. On read it returns an object with type, id, and name. On write, pass { "id": "element_id" }, or null to clear. The referenced element must be of type GROUP_PEER_REVIEW and must belong to the same course.

Questions
The questions property accepts an array of reflection question objects. The entire questions array is replaced on every update (full replacement, not merge). Each question has a type that determines its structure.

Question types: TEXT, TEXT_SCALE, NUMBER_SCALE, YES_NO, INFO_BOX

Common fields (all types):
  • id (string, optional) — Existing question ID to preserve.
  • type (string, required) — The question type.
  • text (string, required) — The question text.
  • optional (boolean, optional) — Whether the question is optional. Default: false.

TEXT: min_words (integer)
NUMBER_SCALE: range_min (integer), range_max (integer)
TEXT_SCALE: options (array of { text }) — ordered from lowest to highest score.
YES_NO: yes_text (string), no_text (string)
INFO_BOX: no additional fields

CERTIFICATE
  • certificate_title (string) — The certificate title.
  • certificate_description (string) — The certificate description.
  • certificate_course_name (string) — The course name displayed on the certificate.
  • certificate_issued_by (string) — The issuer name displayed on the certificate.

.

Example: {"video_url":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"}

Create element › Responses

200

error

string

payload

object

POST/v0/elements

curl --request POST \
  --url https://api.teachfloor.com/v0/elements \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "First knowledge",
  "content": "# Element Introduction\\nWelcome to the **first element**.",
  "module": "no0aApWNyRMD68rv",
  "position": 0,
  "type": "QUIZ",
  "metadata": {
    "category": "marketing"
  },
  "properties": {
    "video_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
  }
}
'

shell

Example Request Body

{
  "name": "First knowledge",
  "content": "# Element Introduction\\nWelcome to the **first element**.",
  "module": "no0aApWNyRMD68rv",
  "position": 0,
  "type": "QUIZ",
  "metadata": {
    "category": "marketing"
  },
  "properties": {
    "video_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
  }
}

json

Example Responses

{
  "error": null,
  "payload": {
    "data": {
      "id": "QB8nmEJjqdbLA2K5",
      "object": "element",
      "created_at": "2024-11-26T11:37:16.000000Z",
      "name": "Multiple Choice Quiz",
      "cover": null,
      "type": "QUIZ",
      "content": null,
      "position": 3,
      "course": "B4peAvmZ1L9OY3Xr",
      "module": "no0aApWNyRMD68rv",
      "metadata": {},
      "properties": {
        "passing_score": 70,
        "completion_trigger": "on_pass"
      }
    }
  }
}

json

application/json

Retrieve an Element

GET

https://api.teachfloor.com

/v0/elements/{id}

Retrieves the details of an existing element in your organization based on the provided unique element ID. Returns comprehensive information about the element, including its name, type, content, position, and type-specific properties.

Retrieve an Element › path Parameters

id

string · required

The ID of the requested element to update.

Retrieve an Element › Headers

Authorization

string

Content-Type

string

Accept

string

Retrieve an Element › Responses

200

error

string

payload

object

Update element

POST

https://api.teachfloor.com

/v0/elements/{id}

Updates the details of an existing element in your organization based on the provided unique element ID. Any parameters not provided will be left unchanged. Returns the updated element details upon successful update.

Update element › path Parameters

id

string · required

The ID of the requested element to update.

Update element › Headers

Authorization

string

Content-Type

string

Accept

string

Update element › Request Body optional

name

string

The element name. Must not be greater than 255 characters.

Example: Introduction to Marketing

content

string

The element content in markdown format. Supports headings, bold, italic, strikethrough, highlights, inline code, code blocks, blockquotes, lists, tables, images, links, and math (LaTeX).

Example: # Element Introduction\nWelcome to the **first element**.

position

integer

The 0-indexed position of the element within its module. Siblings are re-ordered automatically. Values beyond the last sibling index are clamped to the last position. Must be at least 0.

Example: 2

metadata

string

Example: {"category":"marketing"}

properties

string

Example: {"passing_score":80}

Update element › Responses

200

error

string

payload

object

POST/v0/elements/{id}

curl --request POST \
  --url https://api.teachfloor.com/v0/elements/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Introduction to Marketing",
  "content": "# Element Introduction\\nWelcome to the **first element**.",
  "position": 2,
  "metadata": {
    "category": "marketing"
  },
  "properties": {
    "passing_score": 80
  }
}
'

shell

Example Request Body

{
  "name": "Introduction to Marketing",
  "content": "# Element Introduction\\nWelcome to the **first element**.",
  "position": 2,
  "metadata": {
    "category": "marketing"
  },
  "properties": {
    "passing_score": 80
  }
}

json

Example Responses

{
  "error": null,
  "payload": {
    "data": {
      "id": "QB8nmEJjqdbLA2K5",
      "object": "element",
      "created_at": "2024-11-26T11:37:16.000000Z",
      "name": "Multiple Choice Quiz",
      "cover": null,
      "type": "QUIZ",
      "content": null,
      "position": 3,
      "course": "B4peAvmZ1L9OY3Xr",
      "module": "no0aApWNyRMD68rv",
      "metadata": {},
      "properties": {
        "passing_score": 80,
        "completion_trigger": "on_pass"
      }
    }
  }
}

json

application/json

Delete an Element

DELETE

https://api.teachfloor.com

/v0/elements/{id}

Deletes an existing element in your organization. Returns an object with a deleted parameter upon successful deletion.

Delete an Element › path Parameters

id

string · required

The ID of the requested element to update.

Delete an Element › Headers

Authorization

string

Content-Type

string

Accept

string

Delete an Element › Responses

200

error

string

payload

object

Search Elements

GET

https://api.teachfloor.com

/v0/elements/search

Search for existing elements in your organization. You can search by element name. The search is case-insensitive and supports partial matches.

Search Elements › Headers

Authorization

string

Content-Type

string

Accept

string

Search Elements › Request Body

q

string · required

The search query to filter elements by name.

Example: Quiz

type

string

Must be one of CONTENT, VIDEO, ZOOM_MEETING, MEETING_LINK, QUIZ, SUBMISSION, GROUP_SUBMISSION, EMBED, SURVEY, SCORM, CERTIFICATE, TAG, DATACAMP, SELF_REVIEW, PEER_REVIEW, FEEDBACK_REFLECTION, INSTRUCTOR_REVIEW, INSTRUCTOR_DISCUSSION, AI_REVIEW, CHECKLIST, DISCUSSION, FILE, GROUP_FORMATION, FORM, SCORE, GROUP_PEER_REVIEW, GROUP_FEEDBACK_REFLECTION, or MICROSOFT_TEAMS_MEETING.

Example: FEEDBACK_REFLECTION

Search Elements › Responses

200

GET/v0/elements/search

curl --request GET \
  --url https://api.teachfloor.com/v0/elements/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "q": "Quiz",
  "type": "FEEDBACK_REFLECTION"
}
'

shell

Example Request Body

{
  "q": "Quiz",
  "type": "FEEDBACK_REFLECTION"
}

json

Example Responses

{
  "error": null,
  "payload": {
    "data": [
      {
        "id": "QB8nmEJjqdbLA2K5",
        "object": "element",
        "created_at": "2024-11-26T11:37:16.000000Z",
        "name": "Multiple Choice Quiz",
        "cover": null,
        "type": "QUIZ",
        "content": null,
        "position": 3,
        "course": "B4peAvmZ1L9OY3Xr",
        "module": "no0aApWNyRMD68rv",
        "metadata": {},
        "properties": {}
      },
      "{...}",
      "{...}"
    ],
    "pagination": {
      "total": 3,
      "count": 3,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

json

application/json

Courses Members

Teachfloor

Elements

List all activites

GET

https://api.teachfloor.com

/v0/elements/{id}/activities

List all activites › path Parameters

id

string · required

The ID of the element to retrieve an activities.

List all activites › query Parameters

member

string

The unique ID of the member to filter activities for.

Example: 6K8vojJn1xe14abL

List all activites › Headers

Authorization

string

Content-Type

string

Accept

string

List all activites › Responses

200

GET/v0/elements/{id}/activities

curl --request GET \
  --url https://api.teachfloor.com/v0/elements/:id/activities

shell

Example Responses

{
  "error": null,
  "payload": {
    "data": [
      {
        "id": "KwJ8VgrmlAp4PBnM",
        "object": "activity",
        "timestamp": "2022-11-27T13:52:02.000000Z",
        "status": "PASSED",
        "passed": true,
        "score": 100,
        "completed_by": "6K8vojJn1xe14abL",
        "member": {
          "id": "6K8vojJn1xe14abL",
          "object": "member",
          "first_name": "Adalberto",
          "last_name": "Bruen",
          "full_name": "Adalberto Bruen",
          "avatar": null,
          "email": "iva52@example.org",
          "is_email_verified": true,
          "last_seen": "2024-11-27T13:51:52.000000Z"
        },
        "context": {
          "id": "QB8nmEJjqdbLA2K5",
          "object": "element",
          "created_at": "2024-11-26T11:37:16.000000Z",
          "name": "Multiple Choice Quiz",
          "cover": null,
          "type": "QUIZ",
          "content": null,
          "position": 3,
          "course": "B4peAvmZ1L9OY3Xr",
          "module": "no0aApWNyRMD68rv",
          "metadata": {},
          "properties": {
            "passing_score": 70,
            "completion_trigger": "on_pass"
          }
        }
      },
      "{...}",
      "{...}"
    ],
    "pagination": {
      "total": 3,
      "count": 3,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

json

application/json

List all Elements

GET

https://api.teachfloor.com

/v0/elements

Returns a list of elements within your organization. The elements are sorted by their creation date, with the most recently created elements appearing first.

List all Elements › query Parameters

page

integer

A cursor for pagination across multiple pages of results.

Example: 2

List all Elements › Headers

Authorization

string

Content-Type

string

Accept

string

List all Elements › Responses

200

Create element

POST

https://api.teachfloor.com

/v0/elements

Creates an element in the specified module. Returns the created element details upon successful creation.

Create element › Headers

Authorization

string

Content-Type

string

Accept

string

Create element › Request Body

module

string · required

The module id of the element.

Example: no0aApWNyRMD68rv

name

string

The element name. Must not be greater than 255 characters.

Example: First knowledge

content

string

The element content in markdown format. Supports headings, bold, italic, strikethrough, highlights, inline code, code blocks, blockquotes, lists, tables, images, links, and math (LaTeX).

Example: # Element Introduction\nWelcome to the **first element**.

position

integer

Example: 0

type

string

Example: QUIZ

metadata

string

Example: {"category":"marketing"}

properties

string

Example: {"video_url":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"}

Create element › Responses

200

error

string

payload

object

POST/v0/elements

curl --request POST \
  --url https://api.teachfloor.com/v0/elements \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "First knowledge",
  "content": "# Element Introduction\\nWelcome to the **first element**.",
  "module": "no0aApWNyRMD68rv",
  "position": 0,
  "type": "QUIZ",
  "metadata": {
    "category": "marketing"
  },
  "properties": {
    "video_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
  }
}
'

shell

Example Request Body

{
  "name": "First knowledge",
  "content": "# Element Introduction\\nWelcome to the **first element**.",
  "module": "no0aApWNyRMD68rv",
  "position": 0,
  "type": "QUIZ",
  "metadata": {
    "category": "marketing"
  },
  "properties": {
    "video_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
  }
}

json

Example Responses

{
  "error": null,
  "payload": {
    "data": {
      "id": "QB8nmEJjqdbLA2K5",
      "object": "element",
      "created_at": "2024-11-26T11:37:16.000000Z",
      "name": "Multiple Choice Quiz",
      "cover": null,
      "type": "QUIZ",
      "content": null,
      "position": 3,
      "course": "B4peAvmZ1L9OY3Xr",
      "module": "no0aApWNyRMD68rv",
      "metadata": {},
      "properties": {
        "passing_score": 70,
        "completion_trigger": "on_pass"
      }
    }
  }
}

json

application/json

Retrieve an Element

GET

https://api.teachfloor.com

/v0/elements/{id}

Retrieve an Element › path Parameters

id

string · required

The ID of the requested element to update.

Retrieve an Element › Headers

Authorization

string

Content-Type

string

Accept

string

Retrieve an Element › Responses

200

error

string

payload

object

Update element

POST

https://api.teachfloor.com

/v0/elements/{id}

Update element › path Parameters

id

string · required

The ID of the requested element to update.

Update element › Headers

Authorization

string

Content-Type

string

Accept

string

Update element › Request Body optional

name

string

The element name. Must not be greater than 255 characters.

Example: Introduction to Marketing

content

string

The element content in markdown format. Supports headings, bold, italic, strikethrough, highlights, inline code, code blocks, blockquotes, lists, tables, images, links, and math (LaTeX).

Example: # Element Introduction\nWelcome to the **first element**.

position

integer

The 0-indexed position of the element within its module. Siblings are re-ordered automatically. Values beyond the last sibling index are clamped to the last position. Must be at least 0.

Example: 2

metadata

string

Example: {"category":"marketing"}

properties

string

Example: {"passing_score":80}

Update element › Responses

200

error

string

payload

object

POST/v0/elements/{id}

curl --request POST \
  --url https://api.teachfloor.com/v0/elements/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Introduction to Marketing",
  "content": "# Element Introduction\\nWelcome to the **first element**.",
  "position": 2,
  "metadata": {
    "category": "marketing"
  },
  "properties": {
    "passing_score": 80
  }
}
'

shell

Example Request Body

{
  "name": "Introduction to Marketing",
  "content": "# Element Introduction\\nWelcome to the **first element**.",
  "position": 2,
  "metadata": {
    "category": "marketing"
  },
  "properties": {
    "passing_score": 80
  }
}

json

Example Responses

{
  "error": null,
  "payload": {
    "data": {
      "id": "QB8nmEJjqdbLA2K5",
      "object": "element",
      "created_at": "2024-11-26T11:37:16.000000Z",
      "name": "Multiple Choice Quiz",
      "cover": null,
      "type": "QUIZ",
      "content": null,
      "position": 3,
      "course": "B4peAvmZ1L9OY3Xr",
      "module": "no0aApWNyRMD68rv",
      "metadata": {},
      "properties": {
        "passing_score": 80,
        "completion_trigger": "on_pass"
      }
    }
  }
}

json

application/json

Delete an Element

DELETE

https://api.teachfloor.com

/v0/elements/{id}

Deletes an existing element in your organization. Returns an object with a deleted parameter upon successful deletion.

Delete an Element › path Parameters

id

string · required

The ID of the requested element to update.

Delete an Element › Headers

Authorization

string

Content-Type

string

Accept

string

Delete an Element › Responses

200

error

string

payload

object

Search Elements

GET

https://api.teachfloor.com

/v0/elements/search

Search for existing elements in your organization. You can search by element name. The search is case-insensitive and supports partial matches.

Search Elements › Headers

Authorization

string

Content-Type

string

Accept

string

Search Elements › Request Body

q

string · required

The search query to filter elements by name.

Example: Quiz

type

string

Example: FEEDBACK_REFLECTION

Search Elements › Responses

200

GET/v0/elements/search

curl --request GET \
  --url https://api.teachfloor.com/v0/elements/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "q": "Quiz",
  "type": "FEEDBACK_REFLECTION"
}
'

shell

Example Request Body

{
  "q": "Quiz",
  "type": "FEEDBACK_REFLECTION"
}

json

Example Responses

{
  "error": null,
  "payload": {
    "data": [
      {
        "id": "QB8nmEJjqdbLA2K5",
        "object": "element",
        "created_at": "2024-11-26T11:37:16.000000Z",
        "name": "Multiple Choice Quiz",
        "cover": null,
        "type": "QUIZ",
        "content": null,
        "position": 3,
        "course": "B4peAvmZ1L9OY3Xr",
        "module": "no0aApWNyRMD68rv",
        "metadata": {},
        "properties": {}
      },
      "{...}",
      "{...}"
    ],
    "pagination": {
      "total": 3,
      "count": 3,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

json

application/json

Courses Members