POST api/v2.0/Mentoring/GetParticipants

Returns a paginated list of mentor/mentee participant records. Can only be accessed by an Admin user.

Request Information

URI Parameters

None.

Body Parameters

Role: optional; "mentor" or "mentee" to filter to a single role, omitted to return both, Page: 1-based page number (max 200), ResultsPerPage: number of records per page (max 500).

MentoringParticipantsRequest

Name	Description	Type	Additional information
Role	Optional filter: "mentor" or "mentee". When omitted, both roles are returned.	string	None.
Page	1-based page number. Defaults to 1, capped at 200.	integer	Range: inclusive between 1 and 200
ResultsPerPage	Number of participants to return per page. Defaults to 25, capped at 500.	integer	Range: inclusive between 1 and 500

Request Formats

application/json, text/json

Sample:

{
  "Role": "mentee",
  "Page": 1,
  "ResultsPerPage": 25
}

application/xml, text/xml

Sample:

<MentoringParticipantsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Mentoring">
  <Page>2</Page>
  <ResultsPerPage>3</ResultsPerPage>
  <Role>sample string 1</Role>
</MentoringParticipantsRequest>

Response Information

Resource Description

A page of participant records, plus paging metadata.

MentoringParticipantsResponse

Name	Description	Type	Additional information
Items	Participant records for the requested page.	Collection of MentoringParticipant	None.
Page	The page requested, clamped to at least 1. A page beyond the available data returns an empty Items array.	integer	None.
TotalCount	Total number of participant records across all pages.	integer	None.
HasMore	Whether additional pages exist after this one.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Items": [
    {
      "ContactKey": "05d3b5cb-307e-40ce-8641-79131502c558",
      "Role": "mentor",
      "StatusCode": "A",
      "StartDate": "2025-01-15T00:00:00",
      "EndDate": null,
      "MaximumMentees": 3
    },
    {
      "ContactKey": "e166f8be-bbe2-4e01-98b2-49ddf4086ac8",
      "Role": "mentee",
      "StatusCode": "A",
      "StartDate": "2025-03-02T00:00:00",
      "EndDate": null,
      "MaximumMentees": null
    }
  ],
  "Page": 1,
  "TotalCount": 2,
  "HasMore": false
}

application/xml, text/xml

Sample:

<MentoringParticipantsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Mentoring">
  <HasMore>true</HasMore>
  <Items>
    <MentoringParticipant>
      <ContactKey>eafb4c88-9201-4973-b471-a6c5aefff9e1</ContactKey>
      <EndDate>2026-09-15T20:25:49.5093269-04:00</EndDate>
      <MaximumMentees>1</MaximumMentees>
      <Role>sample string 2</Role>
      <StartDate>2026-09-15T20:25:49.5093269-04:00</StartDate>
      <StatusCode>sample string 3</StatusCode>
    </MentoringParticipant>
    <MentoringParticipant>
      <ContactKey>eafb4c88-9201-4973-b471-a6c5aefff9e1</ContactKey>
      <EndDate>2026-09-15T20:25:49.5093269-04:00</EndDate>
      <MaximumMentees>1</MaximumMentees>
      <Role>sample string 2</Role>
      <StartDate>2026-09-15T20:25:49.5093269-04:00</StartDate>
      <StatusCode>sample string 3</StatusCode>
    </MentoringParticipant>
  </Items>
  <Page>1</Page>
  <TotalCount>2</TotalCount>
</MentoringParticipantsResponse>