headless lms
Organizations

List the organization's team members (staff)

GET /api/organizations/members. List the organization's team members (staff). Headless LMS Organizations API reference.

GET
/api/organizations/members

Staff only (owner, admin, instructor). The team: everyone in the organization who is not a student.

Query Parameters

page?integer
Range1 <= value <= 9007199254740991
Default1
pageSize?integer
Range1 <= value <= 100
Default20
search?string
Lengthlength <= 200
sort?string
role?string

Value in

  • "owner"
  • "admin"
  • "instructor"
  • "moderator"
status?string

Value in

  • "active"
  • "invited"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/organizations/members"
{  "rows": [    {      "id": "string",      "firstName": "string",      "lastName": "string",      "email": "string",      "image": "string",      "role": "owner",      "status": "active",      "joinedAt": "string",      "invitedAt": "string"    }  ],  "total": -9007199254740991,  "page": -9007199254740991,  "pageSize": -9007199254740991}
{  "error": "string",  "message": "string",  "requestId": "string",  "issues": [    {      "path": "string",      "message": "string"    }  ]}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}

Update the active organization (staff) PATCH

PATCH /api/organizations. Update the active organization (staff). Headless LMS Organizations API reference.

Change a member's role (staff) PATCH

PATCH /api/organizations/members/{id}/role. Change a member's role (staff). Headless LMS Organizations API reference.