POST api/v2.0/Mentoring/GetRelationships

Returns a paginated list of mentor/mentee relationship records, each with its request/accept/decline/abandon/end dates. Can only be accessed by an Admin user.

Request Information

URI Parameters

None.

Body Parameters

Page: 1-based page number (max 200), ResultsPerPage: number of relationships per page (max 500).

MentoringRelationshipsRequest

Name	Description	Type	Additional information
Page	1-based page number. Defaults to 1, capped at 200.	integer	Range: inclusive between 1 and 200
ResultsPerPage	Number of relationships to return per page. Defaults to 25, capped at 500.	integer	Range: inclusive between 1 and 500

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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

Response Information

Resource Description

A page of relationship records, plus paging metadata.

MentoringRelationshipsResponse

Name	Description	Type	Additional information
Items	Relationship records for the requested page.	Collection of MentoringRelationship	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 relationship records across all pages.	integer	None.
HasMore	Whether additional pages exist after this one.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Items": [
    {
      "MentorMenteeKey": "9f2ad1a1-4c3d-4e2f-8a1b-1234567890ab",
      "MentorContactKey": "05d3b5cb-307e-40ce-8641-79131502c558",
      "MenteeContactKey": "e166f8be-bbe2-4e01-98b2-49ddf4086ac8",
      "CreatedByType": "Mentee",
      "RequestedByContactKey": "e166f8be-bbe2-4e01-98b2-49ddf4086ac8",
      "RequestDate": "2025-02-01T00:00:00",
      "AcceptDate": "2025-02-03T00:00:00",
      "DeclineDate": null,
      "AbandonDate": null,
      "EndDate": null
    }
  ],
  "Page": 1,
  "TotalCount": 1,
  "HasMore": false
}

application/xml, text/xml

Sample:

<MentoringRelationshipsResponse 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>
    <MentoringRelationship>
      <AbandonDate>2026-09-22T19:12:52.2872597-04:00</AbandonDate>
      <AcceptDate>2026-09-22T19:12:52.2872597-04:00</AcceptDate>
      <CreatedByType>sample string 4</CreatedByType>
      <DeclineDate>2026-09-22T19:12:52.2872597-04:00</DeclineDate>
      <EndDate>2026-09-22T19:12:52.2872597-04:00</EndDate>
      <MenteeContactKey>098b74b8-8f19-48b2-b31d-54f44eb5d710</MenteeContactKey>
      <MentorContactKey>d5218ecd-eb07-438e-9efa-3f5815722e67</MentorContactKey>
      <MentorMenteeKey>c6beeb3f-5a00-4116-b276-4321af7f0014</MentorMenteeKey>
      <RequestDate>2026-09-22T19:12:52.2872597-04:00</RequestDate>
      <RequestedByContactKey>53039290-8834-4c05-ad57-414d65e80d4e</RequestedByContactKey>
    </MentoringRelationship>
    <MentoringRelationship>
      <AbandonDate>2026-09-22T19:12:52.2872597-04:00</AbandonDate>
      <AcceptDate>2026-09-22T19:12:52.2872597-04:00</AcceptDate>
      <CreatedByType>sample string 4</CreatedByType>
      <DeclineDate>2026-09-22T19:12:52.2872597-04:00</DeclineDate>
      <EndDate>2026-09-22T19:12:52.2872597-04:00</EndDate>
      <MenteeContactKey>098b74b8-8f19-48b2-b31d-54f44eb5d710</MenteeContactKey>
      <MentorContactKey>d5218ecd-eb07-438e-9efa-3f5815722e67</MentorContactKey>
      <MentorMenteeKey>c6beeb3f-5a00-4116-b276-4321af7f0014</MentorMenteeKey>
      <RequestDate>2026-09-22T19:12:52.2872597-04:00</RequestDate>
      <RequestedByContactKey>53039290-8834-4c05-ad57-414d65e80d4e</RequestedByContactKey>
    </MentoringRelationship>
  </Items>
  <Page>1</Page>
  <TotalCount>2</TotalCount>
</MentoringRelationshipsResponse>