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.

Courses

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" \
    --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',
        ],
        'json' => [
            'q' => 'Marketing',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://api.teachfloor.com/v0/courses/search"
);

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",
        "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
      },
      {...},
      {...}
    ],
    "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",
        "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
    }
}

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" \
    --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',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://api.teachfloor.com/v0/courses"
);

const params = {
    "page": "2",
};
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",
        "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
      },
      {...},
      {...}
    ],
    "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

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

$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',
        ],
    ]
);
$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"
};

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:

Members

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" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"q\": \"John\"
}"

$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',
        ],
        'json' => [
            'q' => 'John',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://api.teachfloor.com/v0/members/search"
);

const headers = {
    "Authorization": "Bearer {YOUR_API_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "q": "John"
};

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
      },
      {...},
      {...}
    ],
    "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.

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

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" \
    --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',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://api.teachfloor.com/v0/members"
);

const params = {
    "page": "2",
};
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
      },
      {...},
      {...}
    ],
    "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\": \"http:\\/\\/www.luettgen.net\\/\"
}"

$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' => 'http://www.luettgen.net/',
        ],
    ]
);
$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": "http:\/\/www.luettgen.net\/"
};

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

Received response:

Request failed with error:

Request

POST v0/members

Body Parameters

email string

The member's email. Must be a valid email address.

password string

The member's password. Must be at least 8 characters. Must have at least one uppercase and one lowercase letter. Must have at least one number. Must have at least one symbol.

first_name string

The member's first name.

last_name string

The member's last name.

role string

The member's role. It must be "owner", "admin", "lecturer", "assistant" or "customer".

avatar string optional

The member's profile picture. Must be a valid URL.

Organization

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:

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\": 31,
    \"course\": \"e7W6kP8wvjd3GRBz\"
}"

$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' => 31,
            'course' => 'e7W6kP8wvjd3GRBz',
        ],
    ]
);
$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": 31,
    "course": "e7W6kP8wvjd3GRBz"
};

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

Received response:

Request failed with error:

Request

POST v0/invites

Body Parameters

email string

The member's emails to whom will sent an invitation. Must be a valid email address.

full_name string optional

The member's full name.

role string optional

The member's role. Default to "customer". Must be one of customer, lecturer, admin, or owner.

discount_percentage integer optional

Must be between 0 and 100.

course string optional

If set, the ID of the course the member will be invited to.

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.

Introduction

Authenticating requests

Rate Limiting

Courses

Search Courses

Request

Body Parameters

Retrieve a Course

Request

URL Parameters

List all Courses

Request

Query Parameters

Join a Course

Request

URL Parameters

Body Parameters

Revoke Course Access

Request

URL Parameters

Body Parameters

Members

Search Members

Request

Body Parameters

Retrieve a Member

Request

URL Parameters

List all Members

Request

Query Parameters

Create a Member

Request

Body Parameters

Organization

Revoke Organization Access

Request

Body Parameters

Invite Member

Request

Body Parameters

Webhooks

Webhook Retries

Webhook Signature