Courses

Search Courses

GET

https://api.teachfloor.com

/v0/courses/search

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

Search Courses › Headers

Authorization

string

Content-Type

string

Accept

string

Search Courses › Request Body

q

string · required

The search query to filter courses by name.

Example: Marketing

Search Courses › Responses

200

GET/v0/courses/search

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

shell

Example Request Body

{
  "q": "Marketing"
}

json

Example Responses

{
  "error": null,
  "payload": {
    "data": [
      {
        "id": "p5v87ERWKR3dkjyD",
        "object": "course",
        "name": "Ultimate Marketing Course",
        "status": "PUBLISHED",
        "created_at": "2022-02-03T16:06:42.000000Z",
        "cover": null,
        "availability": "CONTINUOUS",
        "visibility": "PRIVATE",
        "start_date": null,
        "end_date": null,
        "currency": "eur",
        "price": null,
        "url": null,
        "public_url": null,
        "join_url": null,
        "metadata": {},
        "custom_fields": {
          "field_1": {
            "key": "field_1",
            "object": "custom-field",
            "created_at": "2024-07-30T16:05:47.000000Z",
            "name": "Multiple Field Question",
            "description": null,
            "type": "MULTIPLE_OPTIONS",
            "options": [
              "Option A",
              "Option B",
              "Option C"
            ],
            "required": false
          }
        }
      },
      "{...}",
      "{...}"
    ],
    "pagination": {
      "total": 5,
      "count": 5,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

json

application/json

Retrieve a Course

GET

https://api.teachfloor.com

/v0/courses/{id}

Retrieves the details of an existing course in your organization based on the provided unique course ID. Returns a comprehensive information about the course, including its name, availability, status, dates, and more.

Retrieve a Course › path Parameters

id

string · required

The ID of the requested course.

Retrieve a Course › Headers

Authorization

string

Content-Type

string

Accept

string

Retrieve a Course › Responses

200

error

string

payload

object

GET/v0/courses/{id}

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

shell

Example Responses

{
  "error": null,
  "payload": {
    "id": "p5v87ERWKR3dkjyD",
    "object": "course",
    "name": "Ultimate Marketing Course",
    "status": "PUBLISHED",
    "created_at": "2022-02-03T16:06:42.000000Z",
    "cover": null,
    "availability": "CONTINUOUS",
    "visibility": "PRIVATE",
    "start_date": null,
    "end_date": null,
    "currency": "eur",
    "price": null,
    "content": null,
    "url": null,
    "public_url": null,
    "join_url": null,
    "metadata": {},
    "custom_fields": {
      "field_1": {
        "key": "field_1",
        "object": "custom-field",
        "created_at": "2024-07-30T16:05:47.000000Z",
        "name": "Multiple Field Question",
        "description": null,
        "type": "MULTIPLE_OPTIONS",
        "options": [
          "Option A",
          "Option B",
          "Option C"
        ],
        "required": false
      }
    }
  }
}

json

application/json

Update a Course

POST

https://api.teachfloor.com

/v0/courses/{id}

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

Update a Course › path Parameters

id

string · required

The ID of the requested course.

Update a Course › Headers

Authorization

string

Content-Type

string

Accept

string

Update a Course › Request Body optional

name

string

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

Example: Ultimate Marketing Course

content

string

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

Example: # Introduction\nWelcome to the **Ultimate Marketing Course**.

availability

string

The course availability. Must be one of: CONTINUOUS, SCHEDULED. Must be one of CONTINUOUS or SCHEDULED.

Example: CONTINUOUS

start_date

string

If the course availability is set to SCHEDULED, this defines the course schedule start. Specify the date in YYYY-MM-DD format. This field is required when availability is SCHEDULED. Must be a valid date.

Example: 2023-07-12

end_date

string

If the course availability is set to SCHEDULED, this defines the course schedule end. Specify the date in YYYY-MM-DD format. This field is required when availability is SCHEDULED or date. Must be a date after or equal to start_date.

Example: 2023-07-26

visibility

string

The course visibility inside your organization. A course with PUBLIC visibility is shown to all the members of your organization. A course with PRIVATE visibility is shown only to the members of the course but is hidden by the other members of your organization. Must be one of PUBLIC or PRIVATE.

Example: PUBLIC

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

Update a Course › Responses

200

error

string

payload

object

POST/v0/courses/{id}

curl --request POST \
  --url https://api.teachfloor.com/v0/courses/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Ultimate Marketing Course",
  "content": "# Introduction\\nWelcome to the **Ultimate Marketing Course**.",
  "availability": "CONTINUOUS",
  "start_date": "2023-07-12",
  "end_date": "2023-07-26",
  "visibility": "PUBLIC",
  "metadata": {
    "category": "marketing"
  }
}
'

shell

Example Request Body

{
  "name": "Ultimate Marketing Course",
  "content": "# Introduction\\nWelcome to the **Ultimate Marketing Course**.",
  "availability": "CONTINUOUS",
  "start_date": "2023-07-12",
  "end_date": "2023-07-26",
  "visibility": "PUBLIC",
  "metadata": {
    "category": "marketing"
  }
}

json

Example Responses

{
  "error": null,
  "payload": {
    "id": "p5v87ERWKR3dkjyD",
    "object": "course",
    "name": "Ultimate Marketing Course",
    "status": "PUBLISHED",
    "created_at": "2022-02-03T16:06:42.000000Z",
    "cover": null,
    "availability": "CONTINUOUS",
    "visibility": "PRIVATE",
    "start_date": null,
    "end_date": null,
    "currency": "eur",
    "price": null,
    "content": "# Introduction\nWelcome to the **Ultimate Marketing Course**.",
    "url": null,
    "public_url": null,
    "join_url": null,
    "metadata": {},
    "custom_fields": {
      "field_1": {
        "key": "field_1",
        "object": "custom-field",
        "created_at": "2024-07-30T16:05:47.000000Z",
        "name": "Multiple Field Question",
        "description": null,
        "type": "MULTIPLE_OPTIONS",
        "options": [
          "Option A",
          "Option B",
          "Option C"
        ],
        "required": false
      }
    }
  }
}

json

application/json

Delete a Course

DELETE

https://api.teachfloor.com

/v0/courses/{id}

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

Delete a Course › path Parameters

id

string · required

The ID of the requested course.

Delete a Course › Headers

Authorization

string

Content-Type

string

Accept

string

Delete a Course › Responses

200

List all Courses

GET

https://api.teachfloor.com

/v0/courses

Returns a list of courses within your organization. The courses are sorted by their creation date, with the most recently created courses appearing first. Each course in the list includes information such as the course name, availability, status, dates, and more.

List all Courses › query Parameters

page

integer

A cursor for pagination across multiple pages of results.

Example: 2

List all Courses › Headers

Authorization

string

Content-Type

string

Accept

string

List all Courses › Responses

200

GET/v0/courses

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

shell

Example Responses

{
  "error": null,
  "payload": {
    "data": [
      {
        "id": "p5v87ERWKR3dkjyD",
        "object": "course",
        "name": "Ultimate Marketing Course",
        "status": "PUBLISHED",
        "created_at": "2022-02-03T16:06:42.000000Z",
        "cover": null,
        "availability": "CONTINUOUS",
        "visibility": "PRIVATE",
        "start_date": null,
        "end_date": null,
        "currency": "eur",
        "price": null,
        "url": null,
        "public_url": null,
        "join_url": null,
        "metadata": {},
        "custom_fields": {
          "field_1": {
            "key": "field_1",
            "object": "custom-field",
            "created_at": "2024-07-30T16:05:47.000000Z",
            "name": "Multiple Field Question",
            "description": null,
            "type": "MULTIPLE_OPTIONS",
            "options": [
              "Option A",
              "Option B",
              "Option C"
            ],
            "required": false
          }
        }
      },
      "{...}",
      "{...}"
    ],
    "pagination": {
      "total": 15,
      "count": 5,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 2
    }
  }
}

json

application/json

Create a Course

POST

https://api.teachfloor.com

/v0/courses

Creates a course in your organization. Returns the created course details upon successful creation.

Create a Course › Headers

Authorization

string

Content-Type

string

Accept

string

Create a Course › Request Body optional

name

string

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

Example: Ultimate Marketing Course

content

string

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

Example: # Introduction\nWelcome to the **Ultimate Marketing Course**.

availability

string

The course availability. Must be one of: CONTINUOUS, SCHEDULED. Must be one of CONTINUOUS or SCHEDULED.

Example: CONTINUOUS

start_date

string

Example: 2023-07-12

end_date

string

Example: 2023-07-26

visibility

string

Example: PUBLIC

metadata

string

Example: {"category":"marketing"}

Create a Course › Responses

200

error

string

payload

object

POST/v0/courses

curl --request POST \
  --url https://api.teachfloor.com/v0/courses \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Ultimate Marketing Course",
  "content": "# Introduction\\nWelcome to the **Ultimate Marketing Course**.",
  "availability": "CONTINUOUS",
  "start_date": "2023-07-12",
  "end_date": "2023-07-26",
  "visibility": "PUBLIC",
  "metadata": {
    "category": "marketing"
  }
}
'

shell

Example Request Body

{
  "name": "Ultimate Marketing Course",
  "content": "# Introduction\\nWelcome to the **Ultimate Marketing Course**.",
  "availability": "CONTINUOUS",
  "start_date": "2023-07-12",
  "end_date": "2023-07-26",
  "visibility": "PUBLIC",
  "metadata": {
    "category": "marketing"
  }
}

json

Example Responses

{
  "error": null,
  "payload": {
    "id": "p5v87ERWKR3dkjyD",
    "object": "course",
    "name": "Ultimate Marketing Course",
    "status": "PUBLISHED",
    "created_at": "2022-02-03T16:06:42.000000Z",
    "cover": null,
    "availability": "CONTINUOUS",
    "visibility": "PRIVATE",
    "start_date": null,
    "end_date": null,
    "currency": "eur",
    "price": null,
    "content": "# Introduction\nWelcome to the **Ultimate Marketing Course**.",
    "url": null,
    "public_url": null,
    "join_url": null,
    "metadata": {},
    "custom_fields": {
      "field_1": {
        "key": "field_1",
        "object": "custom-field",
        "created_at": "2024-07-30T16:05:47.000000Z",
        "name": "Multiple Field Question",
        "description": null,
        "type": "MULTIPLE_OPTIONS",
        "options": [
          "Option A",
          "Option B",
          "Option C"
        ],
        "required": false
      }
    }
  }
}

json

application/json

Join a Course

POST

https://api.teachfloor.com

/v0/courses/{id}/join

Joins a member in one of your courses.

Join a Course › path Parameters

id

string · required

The ID of the course to enroll.

Join a Course › Headers

Authorization

string

Content-Type

string

Accept

string

Join a Course › Request Body

member

string · required

The unique ID of the member who is being added to the course.

Example: e7W6kP8wvjd3GRBz

role

string

The role to assign to the member inside the course. If not set the member will be enrolled to the course as a customer. To assign an instructor or assiatant to the course use lecturer or assistant. Must be one of customer, lecturer, or assistant.

Example: customer

Join a Course › Responses

200

error

string

payload

string

Revoke Course Access

POST

https://api.teachfloor.com

/v0/courses/{id}/revoke

Revokes a member access to a course.

Revoke Course Access › path Parameters

id

string · required

The ID of the course from which the member should be revoked.

Revoke Course Access › Headers

Authorization

string

Content-Type

string

Accept

string

Revoke Course Access › Request Body

member

string · required

The ID of the member to revoke access to the course.

Example: e7W6kP8wvjd3GRBz

Revoke Course Access › Responses

200

error

string

payload

string

List all Course Members

GET

https://api.teachfloor.com

/v0/courses/{id}/members

Returns a list of members within the course.

List all Course Members › path Parameters

id

string · required

The ID of the course from which the members should be retrieved.

List all Course Members › Headers

Authorization

string

Content-Type

string

Accept

string

List all Course Members › Request Body optional

include_test_user

boolean

Include test users to the results if set to true.

Example: false

List all Course Members › Responses

200

GET/v0/courses/{id}/members

curl --request GET \
  --url https://api.teachfloor.com/v0/courses/:id/members \
  --header 'Content-Type: application/json' \
  --data '
{
  "include_test_user": false
}
'

shell

Example Request Body

{
  "include_test_user": false
}

json

Example Responses

{
  "error": null,
  "payload": {
    "data": [
      {
        "id": "6jO9XN7mZEVpvxqo",
        "object": "course_member",
        "joined_at": "2024-01-22T12:56:04.000000Z",
        "member": {
          "id": "e7W6kP8wvjd3GRBz",
          "object": "member",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "avatar": null,
          "email": null,
          "is_email_verified": false,
          "last_seen": "2024-01-22T12:56:04.000000Z"
        },
        "course": {
          "id": "p5v87ERWKR3dkjyD",
          "object": "course",
          "name": "Ultimate Marketing Course",
          "status": "PUBLISHED",
          "created_at": "2022-02-03T16:06:42.000000Z",
          "cover": null,
          "availability": "CONTINUOUS",
          "visibility": "PRIVATE",
          "start_date": null,
          "end_date": null,
          "currency": "eur",
          "price": null,
          "url": null,
          "public_url": null,
          "join_url": null,
          "metadata": {},
          "custom_fields": {
            "field_1": {
              "key": "field_1",
              "object": "custom-field",
              "created_at": "2024-07-30T16:05:47.000000Z",
              "name": "Multiple Field Question",
              "description": null,
              "type": "MULTIPLE_OPTIONS",
              "options": [
                "Option A",
                "Option B",
                "Option C"
              ],
              "required": false
            }
          }
        },
        "custom_fields": {
          "field_1": [
            "Option A",
            "Option B"
          ]
        }
      },
      "{...}",
      "{...}"
    ],
    "pagination": {
      "total": 15,
      "count": 5,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 2
    }
  }
}

json

application/json

List all Course Modules

GET

https://api.teachfloor.com

/v0/courses/{id}/modules

Returns a list of modules within the course.

List all Course Modules › path Parameters

id

string · required

The ID of the course from which the modules should be retrieved.

List all Course Modules › Headers

Authorization

string

Content-Type

string

Accept

string

List all Course Modules › Responses

200

List all Course Elements

GET

https://api.teachfloor.com

/v0/courses/{id}/elements

Returns a list of elements within the course.

List all Course Elements › path Parameters

id

string · required

The ID of the course from which the elements should be retrieved.

List all Course Elements › Headers

Authorization

string

Content-Type

string

Accept

string

List all Course Elements › Responses

200

Retrieve a Course Member

GET

https://api.teachfloor.com

/v0/courses/{id}/members/{member_id}

Retrieves the details of a specific member in a course, including their progress data.

Retrieve a Course Member › path Parameters

id

string · required

The ID of the course.

member_id

string · required

The ID of the member.

Retrieve a Course Member › Headers

Authorization

string

Content-Type

string

Accept

string

Retrieve a Course Member › Responses

200

error

string

payload

object

GET/v0/courses/{id}/members/{member_id}

curl --request GET \
  --url https://api.teachfloor.com/v0/courses/:id/members/:member_id

shell

Example Responses

{
  "error": null,
  "payload": {
    "id": "6jO9XN7mZEVpvxqo",
    "object": "course_member",
    "joined_at": "2024-01-22T12:56:04.000000Z",
    "member": {
      "id": "e7W6kP8wvjd3GRBz",
      "object": "member",
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "avatar": null,
      "email": "john@example.com",
      "is_email_verified": true,
      "last_seen": "2024-01-22T12:56:04.000000Z"
    },
    "course": {
      "id": "p5v87ERWKR3dkjyD",
      "object": "course",
      "name": "Ultimate Marketing Course"
    },
    "custom_fields": {},
    "progress": {
      "is_completed": false,
      "completion_percentage": 65,
      "completed_elements_count": 8,
      "total_elements_count": 12,
      "completed_modules_count": 3,
      "total_modules_count": 5,
      "started_at": "2024-01-22T12:56:04.000000Z",
      "completed_at": null
    }
  }
}

json

application/json

Activities Elements