GET restapi/personal/courses/{courseId}/participants/v1?PageIndex={PageIndex}&PageSize={PageSize}&courseProfileId={courseProfileId}&searchText={searchText}&orderByField={orderByField}&orderAscending={orderAscending}

Gets a list of the course participants for a given course.

Request Information

URI Parameters

Name	Description	Type	Additional information
courseId	The id of the course we want the participants from	integer	Required
PageIndex		integer	None.
PageSize		integer	None.
courseProfileId	Participants with a specific course profile to get. If not present participants with all profiles are returned	integer	None.
searchText	The text to search for (optional)	string	None.
orderByField	[OPTIONAL] The field to sort by.Defaults to fullname. Example usage ?orderbyfield=lastvisited	string	Default value is fullName
orderAscending	[OPTIONAL] Whether we should sort ascending or not. Example usage ?orderAscending=false	boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

EntityListOfItslearning.RestApi.Entities.Personal.Course.CourseParticipant

Name	Type	Additional information
EntityArray	Collection of Itslearning.RestApi.Entities.Personal.Course.CourseParticipant	None.
Total	integer	None.
CurrentPageIndex	integer	None.
PageSize	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "EntityArray": [
    {
      "PersonId": 1,
      "FullName": "sample string 2",
      "LastVisited": "2025-06-25T14:40:37Z",
      "LastVisitedRelative": "sample string 3",
      "PictureUrl": "sample string 4",
      "Role": "sample string 5",
      "RoleId": 6,
      "CompletedTasks": 7,
      "TotalTasks": 8,
      "ExtraInformation": "sample string 9",
      "CanHaveTasks": true,
      "Groups": "sample string 11",
      "TemporaryAccess": true
    },
    {
      "PersonId": 1,
      "FullName": "sample string 2",
      "LastVisited": "2025-06-25T14:40:37Z",
      "LastVisitedRelative": "sample string 3",
      "PictureUrl": "sample string 4",
      "Role": "sample string 5",
      "RoleId": 6,
      "CompletedTasks": 7,
      "TotalTasks": 8,
      "ExtraInformation": "sample string 9",
      "CanHaveTasks": true,
      "Groups": "sample string 11",
      "TemporaryAccess": true
    }
  ],
  "Total": 1,
  "CurrentPageIndex": 2,
  "PageSize": 3
}

application/xml, text/xml

Sample:

<EntityList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CurrentPageIndex>2</CurrentPageIndex>
  <EntityArray>
    <CourseParticipant>
      <CanHaveTasks>true</CanHaveTasks>
      <CompletedTasks>7</CompletedTasks>
      <ExtraInformation>sample string 9</ExtraInformation>
      <FullName>sample string 2</FullName>
      <Groups>sample string 11</Groups>
      <LastVisited>2025-06-25T14:40:37Z</LastVisited>
      <LastVisitedRelative>sample string 3</LastVisitedRelative>
      <PersonId>1</PersonId>
      <PictureUrl>sample string 4</PictureUrl>
      <Role>sample string 5</Role>
      <RoleId>6</RoleId>
      <TemporaryAccess>true</TemporaryAccess>
      <TotalTasks>8</TotalTasks>
    </CourseParticipant>
    <CourseParticipant>
      <CanHaveTasks>true</CanHaveTasks>
      <CompletedTasks>7</CompletedTasks>
      <ExtraInformation>sample string 9</ExtraInformation>
      <FullName>sample string 2</FullName>
      <Groups>sample string 11</Groups>
      <LastVisited>2025-06-25T14:40:37Z</LastVisited>
      <LastVisitedRelative>sample string 3</LastVisitedRelative>
      <PersonId>1</PersonId>
      <PictureUrl>sample string 4</PictureUrl>
      <Role>sample string 5</Role>
      <RoleId>6</RoleId>
      <TemporaryAccess>true</TemporaryAccess>
      <TotalTasks>8</TotalTasks>
    </CourseParticipant>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>