Introduction
The Teachfloor API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Base URL
https://api.teachfloor.com
Authenticating requests
Authenticate requests to this API's endpoints by sending an Authorization header with the value "Bearer {YOUR_API_KEY}".
All authenticated endpoints are marked with a requires authentication badge in the documentation below.
You can retrieve your API Key in Settings > Integrations and clicking Generate API Key.
Rate Limiting
Example response: HTTP/1.1 200 OK X-RateLimit-Limit: 50 X-RateLimit-Remaining: 48
Teachfloor API has a rate limit of 50 requests per minute per API Key.
Each HTTP response includes headers indicating the rate limit status: X-RateLimit-Limit specifies the rate limit per minute, and X-RateLimit-Remaining indicates the remaining rate limit available.
Activities
Activities are the record of a member engaging with an element — a completion, a submission, a score. They are read-only here, and are the source for progress and completion reporting.
Retrieve an Activity
Requires Authentication
Retrieves the details of an existing activity in your organization based on the provided unique activity ID. The response includes comprehensive information about the activity, such as its score, timestamps, associated element details, and related metadata.
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.
The meta object contains additional details and metadata about the activity's completion status. It provides context on the outcome and participant of the activity.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/activities/p5v87ERWKR3dkjyD" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/activities/p5v87ERWKR3dkjyD',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/activities/p5v87ERWKR3dkjyD"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"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",
"position": 3,
"course": "B4peAvmZ1L9OY3Xr",
"module": "no0aApWNyRMD68rv",
"metadata": {}
}
}
Received response:
Request failed with error:
List all Activities
Requires Authentication
Returns a list of activities within your organization. The activities are sorted by their creation date, with the most recently created activities appearing first. Each activity in the list includes information such as the score, dates, element data and more.
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.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/activities?course=B4peAvmZ1L9OY3Xr&module=no0aApWNyRMD68rv&element=QB8nmEJjqdbLA2K5&member=6K8vojJn1xe14abL&page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/activities',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'course'=> 'B4peAvmZ1L9OY3Xr',
'module'=> 'no0aApWNyRMD68rv',
'element'=> 'QB8nmEJjqdbLA2K5',
'member'=> '6K8vojJn1xe14abL',
'page'=> '2',
'limit'=> '3',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/activities"
);
const params = {
"course": "B4peAvmZ1L9OY3Xr",
"module": "no0aApWNyRMD68rv",
"element": "QB8nmEJjqdbLA2K5",
"member": "6K8vojJn1xe14abL",
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"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",
"position": 3,
"course": "B4peAvmZ1L9OY3Xr",
"module": "no0aApWNyRMD68rv",
"metadata": {}
}
},
{...},
{...},
],
"pagination": {
"total": 3,
"count": 3,
"per_page": 10,
"current_page": 1,
"total_pages": 1
}
}
Received response:
Request failed with error:
Courses
Courses are the top level of your content. A course holds modules, a module holds elements, and members are enrolled per course — so a course is also the unit access is granted and revoked against.
Search Courses
Requires Authentication
Search for existing courses in your organization. You can search by course name. The search is case-insensitive and supports partial matches.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/courses/search?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"q\": \"Marketing\"
}"
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/courses/search',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
'json' => [
'q' => 'Marketing',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/courses/search"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"q": "Marketing"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"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": {}
},
{...},
{...}
],
"pagination": {
"total": 5,
"count": 5,
"per_page": 10,
"current_page": 1,
"total_pages": 1
}
}
}
Received response:
Request failed with error:
Retrieve a Course
Requires Authentication
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.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"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": {}
}
}
Received response:
Request failed with error:
List all Courses
Requires Authentication
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.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/courses?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/courses',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/courses"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"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": {}
},
{...},
{...}
],
"pagination": {
"total": 15,
"count": 5,
"per_page": 10,
"current_page": 1,
"total_pages": 2
}
}
}
Received response:
Request failed with error:
Join a Course
Requires Authentication
Joins a member in one of your courses.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/join" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"member\": \"e7W6kP8wvjd3GRBz\",
\"role\": \"lecturer\"
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/join',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'member' => 'e7W6kP8wvjd3GRBz',
'role' => 'lecturer',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/join"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"member": "e7W6kP8wvjd3GRBz",
"role": "lecturer"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": null
}
Received response:
Request failed with error:
Revoke Course Access
Requires Authentication
Revokes a member access to a course.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/revoke" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"member\": \"e7W6kP8wvjd3GRBz\"
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/revoke',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'member' => 'e7W6kP8wvjd3GRBz',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/revoke"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"member": "e7W6kP8wvjd3GRBz"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": null
}
Received response:
Request failed with error:
Create a Course
Requires Authentication
Creates a course in your organization. Returns the created course details upon successful creation.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/courses" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: 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\"
}
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/courses',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/courses"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let 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"
}
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"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": {}
}
}
Received response:
Request failed with error:
List all Course Members
Requires Authentication
Returns a list of members within the course.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/members?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"include_test_user\": false
}"
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/members',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
'json' => [
'include_test_user' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/members"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"include_test_user": false
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"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": [
"Option A",
"Option B"
]
},
"tags": [
"vip"
]
},
{...},
{...}
],
"pagination": {
"total": 15,
"count": 5,
"per_page": 10,
"current_page": 1,
"total_pages": 2
}
}
}
Received response:
Request failed with error:
List all Course Modules
Requires Authentication
Returns a list of modules within the course.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/courses/LZ6dN0DGgBD3QjxB/modules?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/courses/LZ6dN0DGgBD3QjxB/modules',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/courses/LZ6dN0DGgBD3QjxB/modules"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"data": [
{
"id": "LZ6dN0DGgBD3QjxB",
"object": "module",
"created_at": "2024-01-22T12:55:11.000000Z",
"name": "Lesson #1",
"type": "LESSON",
"availability": "CONTINUOUS",
"position": 0,
"course": "B4peAvmZ1L9OY3Xr",
"metadata": {}
},
{...},
{...}
],
"pagination": {
"total": 15,
"count": 5,
"per_page": 10,
"current_page": 1,
"total_pages": 2
}
}
}
Received response:
Request failed with error:
List all Course Elements
Requires Authentication
Returns a list of elements within the course.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/courses/WYxKj5OlrekVAGr7/elements?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/courses/WYxKj5OlrekVAGr7/elements',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/courses/WYxKj5OlrekVAGr7/elements"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"data": [
{
"id": "WYxKj5OlrekVAGr7",
"object": "element",
"created_at": "2024-01-22T12:55:11.000000Z",
"name": "Introduction",
"cover": null,
"type": "CONTENT",
"position": 0,
"module": "LZ6dN0DGgBD3QjxB",
"metadata": {},
"properties": {}
},
{...},
{...}
],
"pagination": {
"total": 15,
"count": 5,
"per_page": 10,
"current_page": 1,
"total_pages": 2
}
}
}
Received response:
Request failed with error:
Update a Course
Requires Authentication
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.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: 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\"
}
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let 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"
}
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"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": {}
}
}
Received response:
Request failed with error:
Delete a Course
Requires Authentication
Deletes a course in your organization. Returns an object with a deleted parameter upon successful deletion.
Example request:
curl --request DELETE \
"https://api.teachfloor.com/v0/courses/1" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->delete(
'https://api.teachfloor.com/v0/courses/1',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/courses/1"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"id": "p5v87ERWKR3dkjyD",
"object": "course",
"deleted": true,
}
}
Received response:
Request failed with error:
Retrieve a Course Member
Requires Authentication
Retrieves the details of a specific member in a course, including their progress data.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/members/e7W6kP8wvjd3GRBz" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/members/e7W6kP8wvjd3GRBz',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/members/e7W6kP8wvjd3GRBz"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"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": {
"field_1": [
"Option A",
"Option B"
],
"field_12": "Vegetarian"
},
"tags": [
"vip",
"beta-cohort"
],
"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
}
}
}
Received response:
Request failed with error:
List all Course Custom Fields
Requires Authentication
Returns the custom fields defined on the course — the ones whose values are carried on a course member. Use the key of each field when writing values for a member of this course.
A course either uses the organization-wide set of course fields or its own, depending on how it is configured; this endpoint returns whichever applies. Courses with custom fields switched off return an empty list.
These are separate from the organization fields carried on a member, which are listed by the custom fields endpoint.
The full list is returned in a single response; this endpoint is not paginated.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/custom-fields" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/custom-fields',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/custom-fields"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": [
{
"key": "field_12",
"object": "custom-field",
"created_at": "2024-07-30T16:05:47.000000Z",
"name": "Dietary requirements",
"description": null,
"type": "SINGLE_OPTION",
"options": [
"None",
"Vegetarian",
"Vegan"
],
"required": false
}
]
}
Received response:
Request failed with error:
Update a Course Member
Requires Authentication
Updates a member's enrollment in one of your courses. Currently the member's course custom field values are the writable data; any parameters not provided are left unchanged. Returns the updated course member.
The values written here are the course's own enrollment fields. The organization-level fields carried on a member are written through the member endpoints instead.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/members/e7W6kP8wvjd3GRBz" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"custom_fields\": {
\"field_12\": \"Vegetarian\"
},
\"tags\": [
\"vip\",
\"beta-cohort\"
]
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/members/e7W6kP8wvjd3GRBz',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'custom_fields' => [
'field_12' => 'Vegetarian',
],
'tags' => [
'vip',
'beta-cohort',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/courses/p5v87ERWKR3dkjyD/members/e7W6kP8wvjd3GRBz"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"custom_fields": {
"field_12": "Vegetarian"
},
"tags": [
"vip",
"beta-cohort"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"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": null,
"is_email_verified": false,
"last_seen": "2024-01-22T12:56:04.000000Z"
},
"course": {
"id": "p5v87ERWKR3dkjyD",
"object": "course",
"name": "Ultimate Marketing Course"
},
"custom_fields": {
"field_12": "Vegetarian"
},
"tags": [
"vip",
"beta-cohort"
],
"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
}
}
}
Received response:
Request failed with error:
Elements
Elements are the individual pieces of content inside a module — a lesson, a video, a quiz, a submission, a discussion. An element is what a learner completes, which is why activity records are recorded against one.
List all activites
Requires Authentication
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.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/elements/e7W6kP8wvjd3GRBz/activities?member=6K8vojJn1xe14abL&page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/elements/e7W6kP8wvjd3GRBz/activities',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'member'=> '6K8vojJn1xe14abL',
'page'=> '2',
'limit'=> '3',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/elements/e7W6kP8wvjd3GRBz/activities"
);
const params = {
"member": "6K8vojJn1xe14abL",
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"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
}
}
Received response:
Request failed with error:
Create element
Requires Authentication
Creates an element in the specified module. Returns the created element details upon successful creation.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/elements" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: 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\"
}
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/elements',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/elements"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let 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"
}
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"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"
}
}
}
}
Received response:
Request failed with error:
Update element
Requires Authentication
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.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/elements/p5v87ERWKR3dkjyD" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Introduction to Marketing\",
\"content\": \"# Element Introduction\\\\nWelcome to the **first element**.\",
\"position\": 2,
\"metadata\": {
\"category\": \"marketing\"
},
\"properties\": {
\"passing_score\": 80
}
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/elements/p5v87ERWKR3dkjyD',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Introduction to Marketing',
'content' => '# Element Introduction\\nWelcome to the **first element**.',
'position' => 2,
'metadata' => [
'category' => 'marketing',
],
'properties' => [
'passing_score' => 80,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/elements/p5v87ERWKR3dkjyD"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Introduction to Marketing",
"content": "# Element Introduction\\nWelcome to the **first element**.",
"position": 2,
"metadata": {
"category": "marketing"
},
"properties": {
"passing_score": 80
}
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"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"
}
}
}
}
Received response:
Request failed with error:
Search Elements
Requires Authentication
Search for existing elements in your organization. You can search by element name. The search is case-insensitive and supports partial matches.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/elements/search?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"q\": \"Quiz\",
\"type\": \"EMBED\"
}"
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/elements/search',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
'json' => [
'q' => 'Quiz',
'type' => 'EMBED',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/elements/search"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"q": "Quiz",
"type": "EMBED"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"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
}
}
}
Received response:
Request failed with error:
Retrieve an Element
Requires Authentication
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.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/elements/QB8nmEJjqdbLA2K5" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/elements/QB8nmEJjqdbLA2K5',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/elements/QB8nmEJjqdbLA2K5"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"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"
}
}
}
}
Received response:
Request failed with error:
List all Elements
Requires Authentication
Returns a list of elements within your organization. The elements are sorted by their creation date, with the most recently created elements appearing first.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/elements?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/elements',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/elements"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"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": 15,
"count": 5,
"per_page": 10,
"current_page": 1,
"total_pages": 2
}
}
}
Received response:
Request failed with error:
Delete an Element
Requires Authentication
Deletes an existing element in your organization. Returns an object with a deleted parameter upon successful deletion.
Example request:
curl --request DELETE \
"https://api.teachfloor.com/v0/elements/QB8nmEJjqdbLA2K5" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->delete(
'https://api.teachfloor.com/v0/elements/QB8nmEJjqdbLA2K5',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/elements/QB8nmEJjqdbLA2K5"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"id": "QB8nmEJjqdbLA2K5",
"object": "element",
"deleted": true
}
}
Received response:
Request failed with error:
Members
Members are the people in your organization. Membership is separate from course enrollment: creating a member admits someone to the organization, and they reach a course only once enrolled in it.
Search Members
Requires Authentication
Search for existing members in your organization. You can search by first name, last name or email. The search is case-insensitive and supports partial matches.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/members/search?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"q\": \"John\",
\"include_test_user\": false
}"
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/members/search',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
'json' => [
'q' => 'John',
'include_test_user' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/members/search"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"q": "John",
"include_test_user": false
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"data": [
{
"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",
"custom_fields": {
"field_7": "Head of Product",
"field_9": [
"Design",
"Marketing"
]
}
},
{...},
{...}
],
"pagination": {
"total": 5,
"count": 5,
"per_page": 10,
"current_page": 1,
"total_pages": 1
}
}
}
Received response:
Request failed with error:
Retrieve a Member
Requires Authentication
Retrieves the details of an existing member in your organization based on the provided unique member ID. Returns a comprehensive information about the member, including their first name, last name, email, and profile image.
The custom_fields object holds the member's organization-level custom field values, keyed by the field's key. It is also returned by the member list and search endpoints; members embedded in other resources do not include it.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/members/e7W6kP8wvjd3GRBz" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/members/e7W6kP8wvjd3GRBz',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/members/e7W6kP8wvjd3GRBz"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"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",
"custom_fields": {
"field_7": "Head of Product",
"field_9": [
"Design",
"Marketing"
]
}
}
}
Received response:
Request failed with error:
List all Members
Requires Authentication
Retrieves a paginated list of members in your organization. This API endpoint allows you to retrieve detailed information about each member, including their name, email, and other relevant details.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/members?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/members',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/members"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"data": [
{
"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",
"custom_fields": {
"field_7": "Head of Product",
"field_9": [
"Design",
"Marketing"
]
}
},
{...},
{...}
],
"pagination": {
"total": 152,
"count": 10,
"per_page": 10,
"current_page": 1,
"total_pages": 16
}
}
}
Received response:
Request failed with error:
Create a Member
Requires Authentication
Create a member in your organization.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/members" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"john.doe@example.com\",
\"password\": \"doNotU5e_thiSPassw0rd\",
\"first_name\": \"John\",
\"last_name\": \"Doe\",
\"role\": \"lecturer\",
\"avatar\": \"https:\\/\\/example.com\\/avatar.png\",
\"custom_fields\": {
\"field_7\": \"Head of Product\"
}
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/members',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'email' => 'john.doe@example.com',
'password' => 'doNotU5e_thiSPassw0rd',
'first_name' => 'John',
'last_name' => 'Doe',
'role' => 'lecturer',
'avatar' => 'https://example.com/avatar.png',
'custom_fields' => [
'field_7' => 'Head of Product',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/members"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email": "john.doe@example.com",
"password": "doNotU5e_thiSPassw0rd",
"first_name": "John",
"last_name": "Doe",
"role": "lecturer",
"avatar": "https:\/\/example.com\/avatar.png",
"custom_fields": {
"field_7": "Head of Product"
}
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"id": "e7W6kP8wvjd3GRBz",
"object": "member",
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"avatar": null,
"email": "john.doe@example.com",
"is_email_verified": false,
"last_seen": "2024-01-22T12:56:04.000000Z",
"custom_fields": {
"field_7": "Head of Product"
}
}
}
Received response:
Request failed with error:
List all Member Courses
Requires Authentication
Returns a list of courses the member belongs to.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/members/e7W6kP8wvjd3GRBz/courses?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/members/e7W6kP8wvjd3GRBz/courses',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/members/e7W6kP8wvjd3GRBz/courses"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"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",
"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": [
"Option A",
"Option B"
]
},
"tags": [
"vip"
]
},
{...},
{...}
],
"pagination": {
"total": 15,
"count": 5,
"per_page": 10,
"current_page": 1,
"total_pages": 2
}
}
}
Received response:
Request failed with error:
Update a Member
Requires Authentication
Updates the details of an existing member in your organization based on the provided unique member ID. Any parameters not provided will be left unchanged. Returns the updated member details upon successful update.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/members/p5v87ERWKR3dkjyD" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"john.doe@example.com\",
\"password\": \"doNotU5e_thiSPassw0rd\",
\"first_name\": \"John\",
\"last_name\": \"Doe\",
\"avatar\": \"https:\\/\\/example.com\\/avatar.png\",
\"custom_fields\": {
\"field_7\": \"Head of Product\"
}
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/members/p5v87ERWKR3dkjyD',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'email' => 'john.doe@example.com',
'password' => 'doNotU5e_thiSPassw0rd',
'first_name' => 'John',
'last_name' => 'Doe',
'avatar' => 'https://example.com/avatar.png',
'custom_fields' => [
'field_7' => 'Head of Product',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/members/p5v87ERWKR3dkjyD"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email": "john.doe@example.com",
"password": "doNotU5e_thiSPassw0rd",
"first_name": "John",
"last_name": "Doe",
"avatar": "https:\/\/example.com\/avatar.png",
"custom_fields": {
"field_7": "Head of Product"
}
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"id": "e7W6kP8wvjd3GRBz",
"object": "member",
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"avatar": null,
"email": "john.doe@example.com",
"is_email_verified": false,
"last_seen": "2024-01-22T12:56:04.000000Z",
"custom_fields": {
"field_7": "Head of Product",
"field_9": [
"Design",
"Marketing"
]
}
}
}
Received response:
Request failed with error:
List a Member's Teams
Requires Authentication
Returns the teams of your organization the member belongs to. Each item is the assignment, with the member and the team nested.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/members/e7W6kP8wvjd3GRBz/teams?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/members/e7W6kP8wvjd3GRBz/teams',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/members/e7W6kP8wvjd3GRBz/teams"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"data": [
{
"id": "Vzo2KDjObalAXmMa",
"object": "team_member",
"joined_at": "2026-03-02T10:15:00.000000Z",
"member": {
"id": "e7W6kP8wvjd3GRBz",
"object": "member",
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"avatar": null,
"email": "john.doe@example.com",
"is_email_verified": true,
"last_seen": "2026-03-01T09:00:00.000000Z"
},
"team": {
"id": "mX3kLp9QwR2tVb7Y",
"object": "team",
"created_at": "2026-03-01T09:00:00.000000Z",
"name": "Sales EMEA",
"description": "Account executives, EMEA region",
"assign_tag": true
}
}
],
"pagination": {
"total": 1,
"count": 1,
"per_page": 10,
"current_page": 1,
"total_pages": 1
}
}
}
Received response:
Request failed with error:
Modules
Modules are the ordered sections of a course. They carry no content themselves: they group the elements a learner works through, and their position decides the order those appear in.
Create a module
Requires Authentication
Create a module in the specified course. Returns the created module details upon successful creation.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/modules" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: 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\"
}
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/modules',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/modules"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let 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"
}
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"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": {}
}
}
Received response:
Request failed with error:
Update a module
Requires Authentication
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.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/modules/p5v87ERWKR3dkjyD" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: 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\"
}
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/modules/p5v87ERWKR3dkjyD',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'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',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/modules/p5v87ERWKR3dkjyD"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let 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"
}
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"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": {}
}
}
Received response:
Request failed with error:
Search Modules
Requires Authentication
Search for existing modules in your organization. You can search by module name. The search is case-insensitive and supports partial matches.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/modules/search?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"q\": \"Introduction\"
}"
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/modules/search',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
'json' => [
'q' => 'Introduction',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/modules/search"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"q": "Introduction"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"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
}
}
}
Received response:
Request failed with error:
Retrieve a Module
Requires Authentication
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.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/modules/e7W6kP8wvjd3GRBz" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/modules/e7W6kP8wvjd3GRBz',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/modules/e7W6kP8wvjd3GRBz"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"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": {}
}
}
}
Received response:
Request failed with error:
List Module Elements
Requires Authentication
Returns a list of elements within the specified module.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/modules/e7W6kP8wvjd3GRBz/elements?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/modules/e7W6kP8wvjd3GRBz/elements',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/modules/e7W6kP8wvjd3GRBz/elements"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"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
}
}
}
Received response:
Request failed with error:
List all Modules
Requires Authentication
Returns a list of modules within your organization. The modules are sorted by their creation date, with the most recently created modules appearing first.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/modules?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/modules',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/modules"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"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
}
}
}
Received response:
Request failed with error:
Delete a Module
Requires Authentication
Deletes an existing module in your organization. Returns an object with a deleted parameter upon successful deletion.
Example request:
curl --request DELETE \
"https://api.teachfloor.com/v0/modules/e7W6kP8wvjd3GRBz" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->delete(
'https://api.teachfloor.com/v0/modules/e7W6kP8wvjd3GRBz',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/modules/e7W6kP8wvjd3GRBz"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"id": "e7W6kP8wvjd3GRBz",
"object": "module",
"deleted": true
}
}
Received response:
Request failed with error:
Organization
Organization-level operations that sit outside any single course: inviting people, revoking their access, and reading the custom field definitions that members and course members can carry values for.
Revoke Organization Access
Requires Authentication
Revoke a member access from organization.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/revoke" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"member\": \"e7W6kP8wvjd3GRBz\"
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/revoke',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'member' => 'e7W6kP8wvjd3GRBz',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/revoke"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"member": "e7W6kP8wvjd3GRBz"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": null
}
Received response:
Request failed with error:
List all Custom Fields
Requires Authentication
Returns the custom fields defined on your organization — the ones whose values are carried on a member. Use the key of each field when writing values through the member endpoints.
Course enrollment fields are a separate set; retrieve them from the course custom fields endpoint.
The full list is returned in a single response; this endpoint is not paginated.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/custom-fields" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/custom-fields',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/custom-fields"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": [
{
"key": "field_7",
"object": "custom-field",
"created_at": "2024-07-30T16:05:47.000000Z",
"name": "Job title",
"description": null,
"type": "TEXT",
"required": true
},
{
"key": "field_9",
"object": "custom-field",
"created_at": "2024-07-30T16:05:47.000000Z",
"name": "Interests",
"description": null,
"type": "MULTIPLE_OPTIONS",
"options": [
"Design",
"Marketing",
"Engineering"
],
"required": false
},
{
"key": "field_11",
"object": "custom-field",
"created_at": "2024-07-30T16:05:47.000000Z",
"name": "Years of experience",
"description": null,
"type": "NUMERICAL",
"required": false,
"min": 1,
"max": 10
}
]
}
Received response:
Request failed with error:
Invite Member
Requires Authentication
Invite a member to join the organization or course.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/invites" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"john.doe@example.com\",
\"full_name\": \"John Doe\",
\"role\": \"customer\",
\"discount_percentage\": 89,
\"course\": \"e7W6kP8wvjd3GRBz\",
\"skip_email\": false
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/invites',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'email' => 'john.doe@example.com',
'full_name' => 'John Doe',
'role' => 'customer',
'discount_percentage' => 89,
'course' => 'e7W6kP8wvjd3GRBz',
'skip_email' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/invites"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email": "john.doe@example.com",
"full_name": "John Doe",
"role": "customer",
"discount_percentage": 89,
"course": "e7W6kP8wvjd3GRBz",
"skip_email": false
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"id": "R8dXqkpL1BaJl92y",
"object": "invite",
"token": "PgvInCUzTnNuTYpYWb2c",
"url": null,
"full_name": "John Doe",
"role": "customer",
"discount_percentage": 0,
"course": null,
"skip_email": false
}
}
Received response:
Request failed with error:
Teams
Teams are named groups of members. Assigning a course to a team enrolls every member of the team in it, and members added to the team later are enrolled in every course the team is assigned to.
Search Teams
Requires Authentication
Searches the teams in your organization by name or description.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/teams/search?q=Sales&page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"q\": \"sit\"
}"
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/teams/search',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'q'=> 'Sales',
'page'=> '2',
'limit'=> '3',
],
'json' => [
'q' => 'sit',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/teams/search"
);
const params = {
"q": "Sales",
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"q": "sit"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"data": [
{
"id": "mX3kLp9QwR2tVb7Y",
"object": "team",
"created_at": "2026-03-01T09:00:00.000000Z",
"name": "Sales EMEA",
"description": "Account executives, EMEA region",
"assign_tag": true
}
],
"pagination": {
"total": 1,
"count": 1,
"per_page": 10,
"current_page": 1,
"total_pages": 1
}
}
}
Received response:
Request failed with error:
Retrieve a Team
Requires Authentication
Retrieves the details of a team in your organization.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"id": "mX3kLp9QwR2tVb7Y",
"object": "team",
"created_at": "2026-03-01T09:00:00.000000Z",
"name": "Sales EMEA",
"description": "Account executives, EMEA region",
"assign_tag": true
}
}
Received response:
Request failed with error:
List all Teams
Requires Authentication
Returns a paginated list of the teams in your organization, newest first.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/teams?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/teams',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/teams"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"data": [
{
"id": "mX3kLp9QwR2tVb7Y",
"object": "team",
"created_at": "2026-03-01T09:00:00.000000Z",
"name": "Sales EMEA",
"description": "Account executives, EMEA region",
"assign_tag": true
}
],
"pagination": {
"total": 1,
"count": 1,
"per_page": 10,
"current_page": 1,
"total_pages": 1
}
}
}
Received response:
Request failed with error:
List Team Members
Requires Authentication
Returns a paginated list of the members of a team. Each item is the assignment, with the member and the team nested.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/members?include_test_user=&page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/members',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'include_test_user'=> '0',
'page'=> '2',
'limit'=> '3',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/members"
);
const params = {
"include_test_user": "0",
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"data": [
{
"id": "Vzo2KDjObalAXmMa",
"object": "team_member",
"joined_at": "2026-03-02T10:15:00.000000Z",
"member": {
"id": "e7W6kP8wvjd3GRBz",
"object": "member",
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"avatar": null,
"email": "john.doe@example.com",
"is_email_verified": true,
"last_seen": "2026-03-01T09:00:00.000000Z"
},
"team": {
"id": "mX3kLp9QwR2tVb7Y",
"object": "team",
"created_at": "2026-03-01T09:00:00.000000Z",
"name": "Sales EMEA",
"description": "Account executives, EMEA region",
"assign_tag": true
}
}
],
"pagination": {
"total": 1,
"count": 1,
"per_page": 10,
"current_page": 1,
"total_pages": 1
}
}
}
Received response:
Request failed with error:
List Team Courses
Requires Authentication
Returns a paginated list of the courses assigned to a team. Each item is the assignment, with the course and the team nested.
Example request:
curl --request GET \
--get "https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/courses?page=2&limit=3" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/courses',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page'=> '2',
'limit'=> '3',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/courses"
);
const params = {
"page": "2",
"limit": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"data": [
{
"id": "gMANlEd0yb8BwazP",
"object": "team_course",
"assigned_at": "2026-03-02T10:15:00.000000Z",
"course": {
"id": "p5v87ERWKR3dkjyD",
"object": "course",
"name": "Ultimate Marketing Course",
"status": "PUBLISHED",
"created_at": "2026-02-03T16:06:42.000000Z"
},
"team": {
"id": "mX3kLp9QwR2tVb7Y",
"object": "team",
"created_at": "2026-03-01T09:00:00.000000Z",
"name": "Sales EMEA",
"description": "Account executives, EMEA region",
"assign_tag": true
}
}
],
"pagination": {
"total": 1,
"count": 1,
"per_page": 10,
"current_page": 1,
"total_pages": 1
}
}
}
Received response:
Request failed with error:
Update a Team
Requires Authentication
Updates the name, description or tag behaviour of a team. Only the parameters you send are changed.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Sales EMEA\",
\"description\": \"Account executives, EMEA region\",
\"assign_tag\": false
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Sales EMEA',
'description' => 'Account executives, EMEA region',
'assign_tag' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Sales EMEA",
"description": "Account executives, EMEA region",
"assign_tag": false
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"id": "mX3kLp9QwR2tVb7Y",
"object": "team",
"created_at": "2026-03-01T09:00:00.000000Z",
"name": "Sales EMEA",
"description": "Account executives, EMEA region",
"assign_tag": true
}
}
Received response:
Request failed with error:
Delete a Team
Requires Authentication
Deletes a team. By default its members keep the course access they gained through the team; send revoke_course_access to remove them from those courses as well.
Example request:
curl --request DELETE \
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"revoke_course_access\": false
}"
$client = new \GuzzleHttp\Client();
$response = $client->delete(
'https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'revoke_course_access' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"revoke_course_access": false
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"id": "mX3kLp9QwR2tVb7Y",
"object": "team",
"deleted": true
}
}
Received response:
Request failed with error:
Create a Team
Requires Authentication
Creates a new team in your organization. Assign members and courses with the assign endpoints.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/teams" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Sales EMEA\",
\"description\": \"Account executives, EMEA region\",
\"assign_tag\": false
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/teams',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Sales EMEA',
'description' => 'Account executives, EMEA region',
'assign_tag' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/teams"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Sales EMEA",
"description": "Account executives, EMEA region",
"assign_tag": false
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"id": "mX3kLp9QwR2tVb7Y",
"object": "team",
"created_at": "2026-03-01T09:00:00.000000Z",
"name": "Sales EMEA",
"description": "Account executives, EMEA region",
"assign_tag": true
}
}
Received response:
Request failed with error:
Assign a Member to a Team
Requires Authentication
Assigns a member of your organization to the team and enrolls them in every course the team is assigned to. Assigning a member who is already in the team has no effect.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/members/assign" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"member\": \"e7W6kP8wvjd3GRBz\"
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/members/assign',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'member' => 'e7W6kP8wvjd3GRBz',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/members/assign"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"member": "e7W6kP8wvjd3GRBz"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": null
}
Received response:
Request failed with error:
Unassign a Member from a Team
Requires Authentication
Unassigns a member from the team. By default the member keeps the course access they gained through the team; send revoke_course_access to remove them from those courses as well.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/members/unassign" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"member\": \"e7W6kP8wvjd3GRBz\",
\"revoke_course_access\": false
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/members/unassign',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'member' => 'e7W6kP8wvjd3GRBz',
'revoke_course_access' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/members/unassign"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"member": "e7W6kP8wvjd3GRBz",
"revoke_course_access": false
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": null
}
Received response:
Request failed with error:
Assign a Course to a Team
Requires Authentication
Assigns a course of your organization to the team and enrolls every current team member in it. Assigning a course that is already assigned has no effect.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/courses/assign" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"course\": \"p5v87ERWKR3dkjyD\"
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/courses/assign',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'course' => 'p5v87ERWKR3dkjyD',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/courses/assign"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"course": "p5v87ERWKR3dkjyD"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": null
}
Received response:
Request failed with error:
Unassign a Course from a Team
Requires Authentication
Unassigns a course from the team. By default the team members keep their access to the course; send revoke_course_access to remove them from it as well.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/courses/unassign" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"course\": \"p5v87ERWKR3dkjyD\",
\"revoke_course_access\": false
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/courses/unassign',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'course' => 'p5v87ERWKR3dkjyD',
'revoke_course_access' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/teams/mX3kLp9QwR2tVb7Y/courses/unassign"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"course": "p5v87ERWKR3dkjyD",
"revoke_course_access": false
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": null
}
Received response:
Request failed with error:
Uploads
Uploads put a file into your organization's storage and return a URL for it. That URL is what you then set on an element — a video, a file, a SCORM package — or on a member's avatar.
Upload a file
Requires Authentication
Uploads a file to your organization's storage. Returns the public URL of the uploaded file. The returned URL can be used to set element properties such as video_url, scorm_url, file, or avatar.
Example request:
curl --request POST \
"https://api.teachfloor.com/v0/uploads" \
--header "Authorization: Bearer {YOUR_API_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "file=@/tmp/phpdiZdOc" $client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.teachfloor.com/v0/uploads',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_KEY}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'file',
'contents' => fopen('/tmp/phpdiZdOc', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://api.teachfloor.com/v0/uploads"
);
const headers = {
"Authorization": "Bearer {YOUR_API_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('file', document.querySelector('input[name="file"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());Example response (200):
{
"error": null,
"payload": {
"url": "https://cdn.teachfloor.com/public/123/my-document-1712345678.pdf",
"name": "my-document.pdf",
"mime_type": "application/pdf",
"size": 204800
}
}
Received response:
Request failed with error:
Webhooks
Teachfloor uses webhooks to notify your application when an event happens in your account. Webhooks are particularly useful for asynchronous events like when a new member joins a course, a member has completed an element, or when a course is updated.
You can start receiving event notifications by adding your own webhook endpoint in Developers > Webhooks and clicking on Add Endpoint.
Webhook Retries
Teachfloor webhooks have built-in retry methods for 3xx, 4xx, or 5xx response status codes. If Teachfloor doesn’t quickly receive a 2xx response status code for an event, we will retry calling the webhook after 10 seconds. If that second attempt fails, we will attempt to call the webhook a final time after 100 seconds.
Webhook Signature
Signature verification example:
/**
* Generate the signature using the signing
* secret and the webhook content
*/
$generatedSignature = hash_hmac('sha256', $request->getContent(), $webhookSigningSecret);
/**
* Compare the generated signature with the received
* Teachfloor-Signature header to determine if the
* webhook event is legit
*/
if ($generatedSignature !== $headerSignature) {
/**
* Verification failed
*/
return false;
}
/**
* Legit event, use the webhook content...
*/
Teachfloor will sign the webhook events it sends to your endpoints by including a signature in each event’s Teachfloor-Signature header. This allows you to verify that the events were sent by Teachfloor, not by a third party.
To verify the webhook event signatures, you need to retrieve your endpoint’s secret from your Webhook Endpoints settings. Select an endpoint that you want to obtain the secret for, then click the Reveal Signing Secret button.
Signatures are generated using a hash-based message authentication code (HMAC) with SHA-256. Use the endpoint’s signing secret as the key, convert the event payload to json format and use it as the message in your HMAC-SHA256 function. Compare the generated signature with the received Teachfloor-Signature header to determine if the webhook event is legit.