Members

Search Members

GET

https://api.teachfloor.com

/v0/members/search

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.

Search Members › Headers

Authorization

string

Content-Type

string

Accept

string

Search Members › Request Body

q

string · required

The search query to filter members by first name, last name or email.

Example: John

include_test_user

boolean

Include test users to the search results if set to true.

Example: true

Search Members › Responses

200

GET/v0/members/search

curl --request GET \
  --url https://api.teachfloor.com/v0/members/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "q": "John",
  "include_test_user": true
}
'

shell

Example Request Body

{
  "q": "John",
  "include_test_user": true
}

json

Example Responses

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

json

application/json

Retrieve a Member

GET

https://api.teachfloor.com

/v0/members/{id}

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.

Retrieve a Member › path Parameters

id

string · required

The ID of the requested member.

Retrieve a Member › Headers

Authorization

string

Content-Type

string

Accept

string

Retrieve a Member › Responses

200

error

string

payload

object

Update a Member

POST

https://api.teachfloor.com

/v0/members/{id}

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.

Update a Member › path Parameters

id

string · required

The ID of the requested member.

Update a Member › Headers

Authorization

string

Content-Type

string

Accept

string

Update a Member › Request Body optional

email

string

The member email address.

Example: john.doe@example.com

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.

Example: doNotU5e_thiSPassw0rd

first_name

string

The member first name.

Example: John

last_name

string

The member last name.

Example: Doe

avatar

string

The member profile picture URL.

Example: https://example.com/avatar.png

Update a Member › Responses

200

error

string

payload

object

POST/v0/members/{id}

curl --request POST \
  --url https://api.teachfloor.com/v0/members/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "john.doe@example.com",
  "password": "doNotU5e_thiSPassw0rd",
  "first_name": "John",
  "last_name": "Doe",
  "avatar": "https://example.com/avatar.png"
}
'

shell

Example Request Body

{
  "email": "john.doe@example.com",
  "password": "doNotU5e_thiSPassw0rd",
  "first_name": "John",
  "last_name": "Doe",
  "avatar": "https://example.com/avatar.png"
}

json

Example Responses

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

json

application/json

List all Members

GET

https://api.teachfloor.com

/v0/members

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.

List all Members › query Parameters

page

integer

A cursor for pagination across multiple pages of results.

Example: 2

List all Members › Headers

Authorization

string

Content-Type

string

Accept

string

List all Members › Responses

200

Create a Member

POST

https://api.teachfloor.com

/v0/members

Create a member in your organization.

Create a Member › Headers

Authorization

string

Content-Type

string

Accept

string

Create a Member › Request Body

email

string · required

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

Example: john.doe@example.com

password

string · required

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.

Example: doNotU5e_thiSPassw0rd

first_name

string · required

The member's first name.

Example: John

last_name

string · required

The member's last name.

Example: Doe

role

string · required

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

Example: lecturer

avatar

string

The member's profile picture. Must be a valid URL. Must not be greater than 255 characters.

Example: https://example.com/avatar.png

Create a Member › Responses

200

error

string

payload

object

POST/v0/members

curl --request POST \
  --url https://api.teachfloor.com/v0/members \
  --header 'Content-Type: 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"
}
'

shell

Example Request Body

{
  "email": "john.doe@example.com",
  "password": "doNotU5e_thiSPassw0rd",
  "first_name": "John",
  "last_name": "Doe",
  "role": "lecturer",
  "avatar": "https://example.com/avatar.png"
}

json

Example Responses

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

json

application/json

List all Member Courses

GET

https://api.teachfloor.com

/v0/members/{id}/courses

Returns a list of courses the member belongs to.

List all Member Courses › path Parameters

id

string · required

The ID of the member which the courses should be retrieveds.

List all Member Courses › Headers

Authorization

string

Content-Type

string

Accept

string

List all Member Courses › Responses

200

GET/v0/members/{id}/courses

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

shell

Example Responses

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

json

application/json

Elements Modules

Search Members

GET

https://api.teachfloor.com

/v0/members/search

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.

Search Members › Headers

Authorization

string

Content-Type

string

Accept

string

Search Members › Request Body

q

string · required

The search query to filter members by first name, last name or email.

Example: John

include_test_user

boolean

Include test users to the search results if set to true.

Example: true

Search Members › Responses

200

Retrieve a Member

GET

https://api.teachfloor.com

/v0/members/{id}

Retrieve a Member › path Parameters

id

string · required

The ID of the requested member.

Retrieve a Member › Headers

Authorization

string

Content-Type

string

Accept

string

Retrieve a Member › Responses

200

error

string

payload

object

Update a Member

POST

https://api.teachfloor.com

/v0/members/{id}

Update a Member › path Parameters

id

string · required

The ID of the requested member.

Update a Member › Headers

Authorization

string

Content-Type

string

Accept

string

Update a Member › Request Body optional

email

string

The member email address.

Example: john.doe@example.com

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.

Example: doNotU5e_thiSPassw0rd

first_name

string

The member first name.

Example: John

last_name

string

The member last name.

Example: Doe

avatar

string

The member profile picture URL.

Example: https://example.com/avatar.png

Update a Member › Responses

200

error

string

payload

object

List all Members

GET

https://api.teachfloor.com

/v0/members

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.

List all Members › query Parameters

page

integer

A cursor for pagination across multiple pages of results.

Example: 2

List all Members › Headers

Authorization

string

Content-Type

string

Accept

string

List all Members › Responses

200

Create a Member

POST

https://api.teachfloor.com

/v0/members

Create a member in your organization.

Create a Member › Headers

Authorization

string

Content-Type

string

Accept

string

Create a Member › Request Body

email

string · required

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

Example: john.doe@example.com

password

string · required

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.

Example: doNotU5e_thiSPassw0rd

first_name

string · required

The member's first name.

Example: John

last_name

string · required

The member's last name.

Example: Doe

role

string · required

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

Example: lecturer

avatar

string

The member's profile picture. Must be a valid URL. Must not be greater than 255 characters.

Example: https://example.com/avatar.png

Create a Member › Responses

200

error

string

payload

object

List all Member Courses

GET

https://api.teachfloor.com

/v0/members/{id}/courses

Returns a list of courses the member belongs to.

List all Member Courses › path Parameters

id

string · required

The ID of the member which the courses should be retrieveds.

List all Member Courses › Headers

Authorization

string

Content-Type

string

Accept

string

List all Member Courses › Responses

200