Modules

List all Modules

GET

https://api.teachfloor.com

/v0/modules

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

List all Modules › query Parameters

page

integer

A cursor for pagination across multiple pages of results.

Example: 2

List all Modules › Headers

Authorization

string

Content-Type

string

Accept

string

List all Modules › Responses

200

GET/v0/modules

curl --request GET \
  --url https://api.teachfloor.com/v0/modules

shell

Example Responses

{
  "error": null,
  "payload": {
    "data": [
      {
        "id": "e7W6kP8wvjd3GRBz",
        "object": "module",
        "created_at": "2024-01-22T12:56:04.000000Z",
        "name": "Example module",
        "type": "LESSON",
        "availability": "SCHEDULED",
        "start_date": "2025-02-20T00:00:00.000000Z",
        "end_date": "2025-02-21T00:00:00.000000Z",
        "content": null,
        "position": 1,
        "course": "p5v87ERWKR3dkjyD",
        "metadata": {}
      },
      "{...}",
      "{...}"
    ],
    "pagination": {
      "total": 15,
      "count": 5,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 2
    }
  }
}

json

application/json

Create a module

POST

https://api.teachfloor.com

/v0/modules

Create a module in the specified course. Returns the created module details upon successful creation.

Create a module › Headers

Authorization

string

Content-Type

string

Accept

string

Create a module › Request Body

course

string · required

The course id of the module.

Example: qw0aApAGyRKL69rw

name

string

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

Example: First knowledge

content

string

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

Example: # Module Introduction\nWelcome to the **first module**.

availability

string

Defines the availability of the module. Can be one of the following values: "CONTINUOUS" for an ongoing module or "SCHEDULED" for a module with specific start and end dates. Must be one of CONTINUOUS or SCHEDULED.

Example: CONTINUOUS

start_date

string

The start date of the module. The date should be in ISO 8601 format (e.g., "2025-02-17T00:00:00Z"). This field is required if the availability is "SCHEDULED". This field is required when availability is SCHEDULED. Must be a valid date.

Example: 2025-02-17T00:00:00Z

end_date

string

The end date of the module. The date should be in ISO 8601 format (e.g., "2025-03-18T00:00:00Z"). This field is required if the availability is "SCHEDULED" and must be after the start date. This field is required when availability is SCHEDULED or date. Must be a date after or equal to start_date.

Example: 2025-03-17T00:00:00Z

position

integer

The 0-indexed position of the module within its course. If omitted, the module 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

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"}

Create a module › Responses

200

error

string

payload

object

POST/v0/modules

curl --request POST \
  --url https://api.teachfloor.com/v0/modules \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "First knowledge",
  "content": "# Module Introduction\\nWelcome to the **first module**.",
  "course": "qw0aApAGyRKL69rw",
  "availability": "CONTINUOUS",
  "start_date": "2025-02-17T00:00:00Z",
  "end_date": "2025-03-17T00:00:00Z",
  "position": 0,
  "metadata": {
    "category": "marketing"
  }
}
'

shell

Example Request Body

{
  "name": "First knowledge",
  "content": "# Module Introduction\\nWelcome to the **first module**.",
  "course": "qw0aApAGyRKL69rw",
  "availability": "CONTINUOUS",
  "start_date": "2025-02-17T00:00:00Z",
  "end_date": "2025-03-17T00:00:00Z",
  "position": 0,
  "metadata": {
    "category": "marketing"
  }
}

json

Example Responses

{
  "error": null,
  "payload": {
    "id": "e7W6kP8wvjd3GRBz",
    "object": "module",
    "created_at": "2024-01-22T12:56:04.000000Z",
    "name": "Example module",
    "type": "LESSON",
    "availability": "SCHEDULED",
    "start_date": "2025-02-20T00:00:00.000000Z",
    "end_date": "2025-02-21T00:00:00.000000Z",
    "content": null,
    "position": 1,
    "course": "p5v87ERWKR3dkjyD",
    "metadata": {}
  }
}

json

application/json

Retrieve a Module

GET

https://api.teachfloor.com

/v0/modules/{id}

Retrieves the details of an existing module in your organization based on the provided unique module ID. Returns comprehensive information about the module, including its name, type, availability, position, and dates.

Retrieve a Module › path Parameters

id

string · required

The ID of the requested module to update.

Retrieve a Module › Headers

Authorization

string

Content-Type

string

Accept

string

Retrieve a Module › Responses

200

error

string

payload

object

Update a module

POST

https://api.teachfloor.com

/v0/modules/{id}

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

Update a module › path Parameters

id

string · required

The ID of the requested module to update.

Update a module › Headers

Authorization

string

Content-Type

string

Accept

string

Update a module › Request Body optional

name

string

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

Example: First knowledge

content

string

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

Example: # Module Introduction\nWelcome to the **first module**.

availability

string

Example: CONTINUOUS

start_date

string

Example: 2025-02-17T00:00:00Z

end_date

string

Example: 2025-03-17T00:00:00Z

position

integer

The 0-indexed position of the module within its course. 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"}

Update a module › Responses

200

error

string

payload

object

POST/v0/modules/{id}

curl --request POST \
  --url https://api.teachfloor.com/v0/modules/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "First knowledge",
  "content": "# Module Introduction\\nWelcome to the **first module**.",
  "availability": "CONTINUOUS",
  "start_date": "2025-02-17T00:00:00Z",
  "end_date": "2025-03-17T00:00:00Z",
  "position": 2,
  "metadata": {
    "category": "marketing"
  }
}
'

shell

Example Request Body

{
  "name": "First knowledge",
  "content": "# Module Introduction\\nWelcome to the **first module**.",
  "availability": "CONTINUOUS",
  "start_date": "2025-02-17T00:00:00Z",
  "end_date": "2025-03-17T00:00:00Z",
  "position": 2,
  "metadata": {
    "category": "marketing"
  }
}

json

Example Responses

{
  "error": null,
  "payload": {
    "id": "e7W6kP8wvjd3GRBz",
    "object": "module",
    "created_at": "2024-01-22T12:56:04.000000Z",
    "name": "Example module",
    "type": "LESSON",
    "availability": "SCHEDULED",
    "start_date": "2025-02-20T00:00:00.000000Z",
    "end_date": "2025-02-21T00:00:00.000000Z",
    "content": null,
    "position": 1,
    "course": "p5v87ERWKR3dkjyD",
    "metadata": {}
  }
}

json

application/json

Delete a Module

DELETE

https://api.teachfloor.com

/v0/modules/{id}

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

Delete a Module › path Parameters

id

string · required

The ID of the requested module to update.

Delete a Module › Headers

Authorization

string

Content-Type

string

Accept

string

Delete a Module › Responses

200

error

string

payload

object

Search Modules

GET

https://api.teachfloor.com

/v0/modules/search

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

Search Modules › Headers

Authorization

string

Content-Type

string

Accept

string

Search Modules › Request Body

q

string · required

The search query to filter modules by name.

Example: Introduction

Search Modules › Responses

200

GET/v0/modules/search

curl --request GET \
  --url https://api.teachfloor.com/v0/modules/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "q": "Introduction"
}
'

shell

Example Request Body

{
  "q": "Introduction"
}

json

Example Responses

{
  "error": null,
  "payload": {
    "data": [
      {
        "id": "e7W6kP8wvjd3GRBz",
        "object": "module",
        "created_at": "2024-01-22T12:56:04.000000Z",
        "name": "Introduction to Marketing",
        "type": "LESSON",
        "availability": "CONTINUOUS",
        "start_date": null,
        "end_date": null,
        "content": null,
        "position": 0,
        "course": "p5v87ERWKR3dkjyD",
        "metadata": {}
      },
      "{...}",
      "{...}"
    ],
    "pagination": {
      "total": 3,
      "count": 3,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

json

application/json

List Module Elements

GET

https://api.teachfloor.com

/v0/modules/{id}/elements

Returns a list of elements within the specified module.

List Module Elements › path Parameters

id

string · required

The ID of the module.

List Module Elements › query Parameters

page

integer

A cursor for pagination across multiple pages of results.

Example: 2

List Module Elements › Headers

Authorization

string

Content-Type

string

Accept

string

List Module Elements › Responses

200

GET/v0/modules/{id}/elements

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

shell

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": "e7W6kP8wvjd3GRBz",
        "metadata": {},
        "properties": {}
      },
      "{...}",
      "{...}"
    ],
    "pagination": {
      "total": 5,
      "count": 5,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

json

application/json

Members Organization

Teachfloor

Modules

List all Modules

GET

https://api.teachfloor.com

/v0/modules

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

List all Modules › query Parameters

page

integer

A cursor for pagination across multiple pages of results.

Example: 2

List all Modules › Headers

Authorization

string

Content-Type

string

Accept

string

List all Modules › Responses

200

GET/v0/modules

curl --request GET \
  --url https://api.teachfloor.com/v0/modules

shell

Example Responses

{
  "error": null,
  "payload": {
    "data": [
      {
        "id": "e7W6kP8wvjd3GRBz",
        "object": "module",
        "created_at": "2024-01-22T12:56:04.000000Z",
        "name": "Example module",
        "type": "LESSON",
        "availability": "SCHEDULED",
        "start_date": "2025-02-20T00:00:00.000000Z",
        "end_date": "2025-02-21T00:00:00.000000Z",
        "content": null,
        "position": 1,
        "course": "p5v87ERWKR3dkjyD",
        "metadata": {}
      },
      "{...}",
      "{...}"
    ],
    "pagination": {
      "total": 15,
      "count": 5,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 2
    }
  }
}

json

application/json

Create a module

POST

https://api.teachfloor.com

/v0/modules

Create a module in the specified course. Returns the created module details upon successful creation.

Create a module › Headers

Authorization

string

Content-Type

string

Accept

string

Create a module › Request Body

course

string · required

The course id of the module.

Example: qw0aApAGyRKL69rw

name

string

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

Example: First knowledge

content

string

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

Example: # Module Introduction\nWelcome to the **first module**.

availability

string

Example: CONTINUOUS

start_date

string

Example: 2025-02-17T00:00:00Z

end_date

string

Example: 2025-03-17T00:00:00Z

position

integer

Example: 0

metadata

string

Example: {"category":"marketing"}

Create a module › Responses

200

error

string

payload

object

POST/v0/modules

curl --request POST \
  --url https://api.teachfloor.com/v0/modules \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "First knowledge",
  "content": "# Module Introduction\\nWelcome to the **first module**.",
  "course": "qw0aApAGyRKL69rw",
  "availability": "CONTINUOUS",
  "start_date": "2025-02-17T00:00:00Z",
  "end_date": "2025-03-17T00:00:00Z",
  "position": 0,
  "metadata": {
    "category": "marketing"
  }
}
'

shell

Example Request Body

{
  "name": "First knowledge",
  "content": "# Module Introduction\\nWelcome to the **first module**.",
  "course": "qw0aApAGyRKL69rw",
  "availability": "CONTINUOUS",
  "start_date": "2025-02-17T00:00:00Z",
  "end_date": "2025-03-17T00:00:00Z",
  "position": 0,
  "metadata": {
    "category": "marketing"
  }
}

json

Example Responses

{
  "error": null,
  "payload": {
    "id": "e7W6kP8wvjd3GRBz",
    "object": "module",
    "created_at": "2024-01-22T12:56:04.000000Z",
    "name": "Example module",
    "type": "LESSON",
    "availability": "SCHEDULED",
    "start_date": "2025-02-20T00:00:00.000000Z",
    "end_date": "2025-02-21T00:00:00.000000Z",
    "content": null,
    "position": 1,
    "course": "p5v87ERWKR3dkjyD",
    "metadata": {}
  }
}

json

application/json

Retrieve a Module

GET

https://api.teachfloor.com

/v0/modules/{id}

Retrieve a Module › path Parameters

id

string · required

The ID of the requested module to update.

Retrieve a Module › Headers

Authorization

string

Content-Type

string

Accept

string

Retrieve a Module › Responses

200

error

string

payload

object

Update a module

POST

https://api.teachfloor.com

/v0/modules/{id}

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

Update a module › path Parameters

id

string · required

The ID of the requested module to update.

Update a module › Headers

Authorization

string

Content-Type

string

Accept

string

Update a module › Request Body optional

name

string

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

Example: First knowledge

content

string

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

Example: # Module Introduction\nWelcome to the **first module**.

availability

string

Example: CONTINUOUS

start_date

string

Example: 2025-02-17T00:00:00Z

end_date

string

Example: 2025-03-17T00:00:00Z

position

integer

The 0-indexed position of the module within its course. 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"}

Update a module › Responses

200

error

string

payload

object

POST/v0/modules/{id}

curl --request POST \
  --url https://api.teachfloor.com/v0/modules/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "First knowledge",
  "content": "# Module Introduction\\nWelcome to the **first module**.",
  "availability": "CONTINUOUS",
  "start_date": "2025-02-17T00:00:00Z",
  "end_date": "2025-03-17T00:00:00Z",
  "position": 2,
  "metadata": {
    "category": "marketing"
  }
}
'

shell

Example Request Body

{
  "name": "First knowledge",
  "content": "# Module Introduction\\nWelcome to the **first module**.",
  "availability": "CONTINUOUS",
  "start_date": "2025-02-17T00:00:00Z",
  "end_date": "2025-03-17T00:00:00Z",
  "position": 2,
  "metadata": {
    "category": "marketing"
  }
}

json

Example Responses

{
  "error": null,
  "payload": {
    "id": "e7W6kP8wvjd3GRBz",
    "object": "module",
    "created_at": "2024-01-22T12:56:04.000000Z",
    "name": "Example module",
    "type": "LESSON",
    "availability": "SCHEDULED",
    "start_date": "2025-02-20T00:00:00.000000Z",
    "end_date": "2025-02-21T00:00:00.000000Z",
    "content": null,
    "position": 1,
    "course": "p5v87ERWKR3dkjyD",
    "metadata": {}
  }
}

json

application/json

Delete a Module

DELETE

https://api.teachfloor.com

/v0/modules/{id}

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

Delete a Module › path Parameters

id

string · required

The ID of the requested module to update.

Delete a Module › Headers

Authorization

string

Content-Type

string

Accept

string

Delete a Module › Responses

200

error

string

payload

object

Search Modules

GET

https://api.teachfloor.com

/v0/modules/search

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

Search Modules › Headers

Authorization

string

Content-Type

string

Accept

string

Search Modules › Request Body

q

string · required

The search query to filter modules by name.

Example: Introduction

Search Modules › Responses

200

GET/v0/modules/search

curl --request GET \
  --url https://api.teachfloor.com/v0/modules/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "q": "Introduction"
}
'

shell

Example Request Body

{
  "q": "Introduction"
}

json

Example Responses

{
  "error": null,
  "payload": {
    "data": [
      {
        "id": "e7W6kP8wvjd3GRBz",
        "object": "module",
        "created_at": "2024-01-22T12:56:04.000000Z",
        "name": "Introduction to Marketing",
        "type": "LESSON",
        "availability": "CONTINUOUS",
        "start_date": null,
        "end_date": null,
        "content": null,
        "position": 0,
        "course": "p5v87ERWKR3dkjyD",
        "metadata": {}
      },
      "{...}",
      "{...}"
    ],
    "pagination": {
      "total": 3,
      "count": 3,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

json

application/json

List Module Elements

GET

https://api.teachfloor.com

/v0/modules/{id}/elements

Returns a list of elements within the specified module.

List Module Elements › path Parameters

id

string · required

The ID of the module.

List Module Elements › query Parameters

page

integer

A cursor for pagination across multiple pages of results.

Example: 2

List Module Elements › Headers

Authorization

string

Content-Type

string

Accept

string

List Module Elements › Responses

200

GET/v0/modules/{id}/elements

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

shell

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": "e7W6kP8wvjd3GRBz",
        "metadata": {},
        "properties": {}
      },
      "{...}",
      "{...}"
    ],
    "pagination": {
      "total": 5,
      "count": 5,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

json

application/json

Members Organization