Get one CourseMember

GET

api

content

coursemembers

{id}

Get one CourseMember

curl --request GET \
  --url https://spaces.nexudus.com/api/content/coursemembers/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/coursemembers/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/coursemembers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CourseId": 123,
  "CourseTitle": "<string>",
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerTeamNames": "<string>",
  "CoworkerBillingName": "<string>",
  "LastCompletedLessonId": 123,
  "LastCompletedLessonTitle": "<string>",
  "LastAccess": "<string>",
  "Approved": true,
  "Blocked": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A CourseMember represents a customer’s enrolment in a Course. When a customer signs up to a course through the Members Portal they are automatically added as a CourseMember. Members can also be added manually via the Admin Panel or the API. Each CourseMember record tracks the member’s progress (LastCompletedLessonId, LastAccess) and their access status:

Approved — the member has been approved to access the course content. For public courses this is set automatically on sign-up; for private or paid courses an administrator may need to approve the enrolment.
Blocked — the member has been blocked from accessing the course.

Use CourseCompletedLesson records to query which individual lessons a member has completed.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CourseMember-Read role.

Path Parameters

integer

required

The Id of the CourseMember record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/content/coursemembers/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/coursemembers/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/coursemembers/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the course the member is enrolled in.

string

Title of the course.

integer

ID of the customer enrolled in the course.

string

Whether the enrolled customer is an Individual (1) or a Company (2).

string

Full name of the enrolled customer.

string

Company name of the enrolled customer.

string

Comma-separated list of teams the enrolled customer belongs to.

string

Billing name of the enrolled customer.

integer

ID of the most recently completed lesson for this member.

string

Title of the most recently completed lesson.

string

Date and time the member last accessed the course.

boolean

Whether the member has been approved to access the course content.

boolean

Whether the member has been blocked from accessing the course.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "CourseId": 0,
  "CourseTitle": null,
  "CoworkerId": 0,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerTeamNames": null,
  "CoworkerBillingName": null,
  "LastCompletedLessonId": null,
  "LastCompletedLessonTitle": null,
  "LastAccess": null,
  "Approved": false,
  "Blocked": false,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CourseMember Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple CourseMembersRetrieve multiple CourseMember records by their Ids in a single request.

Get one CourseMember

curl --request GET \
  --url https://spaces.nexudus.com/api/content/coursemembers/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/coursemembers/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/coursemembers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CourseId": 123,
  "CourseTitle": "<string>",
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerTeamNames": "<string>",
  "CoworkerBillingName": "<string>",
  "LastCompletedLessonId": 123,
  "LastCompletedLessonTitle": "<string>",
  "LastAccess": "<string>",
  "Approved": true,
  "Blocked": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200