Get all instructors

POST

public

get-all-instructors

Get all instructors

curl --request POST \
  --url https://backend.codedamn.com/api/public/get-all-instructors \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {}
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "instructors": [
          {
            "fermionInstructorId": "<string>",
            "name": "<string>",
            "email": "[email protected]",
            "profilePhotoUrl": "<string>",
            "tagline": "<string>",
            "longDescriptionMarkdown": "<string>",
            "createdAt": "<string>",
            "lastUpdatedAt": "<string>"
          }
        ]
      }
    }
  }
]

Authorizations

FERMION-API-KEY

string

header

required

Body

application/json

API Request Body

data

object[]

required

Show child attributes

data.data

object

required

Response

200 - application/json

API Response Body

output

object

required

Option 1
Option 2

Show child attributes

output.status

enum<string>

required

Available options:

ok

output.data

object

required

Show child attributes

output.data.instructors

object[]

required

List of all instructors in the school

Show child attributes

output.data.instructors.fermionInstructorId

string

required

Unique identifier for the instructor

Minimum string length: 1

output.data.instructors.name

string

required

Name of the instructor

Minimum string length: 1

output.data.instructors.email

string<email>

required

Email address of the instructor

output.data.instructors.profilePhotoUrl

string<uri>

required

URL of the instructor's profile photo

output.data.instructors.tagline

string

required

Short tagline or title of the instructor

output.data.instructors.longDescriptionMarkdown

string

required

Detailed markdown description of the instructor

output.data.instructors.createdAt

string

required

Timestamp when the instructor was added to the school

output.data.instructors.lastUpdatedAt

string

required

Timestamp when the instructor was last updated

Get login link for user Creates a login link for user for them to login directly into fermion managed LMS. Useful when you have your own system Authentication with the "FERMION-API-KEY" header is required to use this endpoint. Rate limit: Maximum 60 requests in a window of 1m.

⌘I

Get all instructors

curl --request POST \
  --url https://backend.codedamn.com/api/public/get-all-instructors \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {}
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "instructors": [
          {
            "fermionInstructorId": "<string>",
            "name": "<string>",
            "email": "[email protected]",
            "profilePhotoUrl": "<string>",
            "tagline": "<string>",
            "longDescriptionMarkdown": "<string>",
            "createdAt": "<string>",
            "lastUpdatedAt": "<string>"
          }
        ]
      }
    }
  }
]

Using API

Endpoints

Authorizations

Body

Response