Get a list of delegates and their team members via API

Delegates are users who manage other users without breaking or changing the current organizational hierarchy. Any Learn365 user, including line managers and proxy managers, can be a delegate who can manage any user within the organization.

For more information about delegates, see this article.

There are two ways to view delegates and their team members in the Learn365 API:

 

Get a list of delegates and their team members

GET /services/users/v2/Delegates

The request enables you to get a list of delegates and their team members in your organization.

 

Pre-conditions

To send the request, you'll need an API key.

 

Query parameters

Use query option parameters to control the data in the response.

 

Request example


GET /services/users/v2/Delegates

 

Response body parameters

The successful 200 response contains an array of all delegates and their team members in your organization. In this array, every element is a separate delegate-team member assignment. If a delegate manages multiple team members, each assignment is listed separately. 

Every element in the array has the following parameters:

  • delegateId (string). The user ID of a delegate.
  • teamMemberId (string). The user ID of a team member.
  • isDeleted (boolean). States whether the delegate assignment was deleted (true) or not (false).
  • delegate (object) and teamMember (object). Each of these objects contains the following details about a delegate and their team member, respectively:
    • id (string). The user ID.
    • title (string). The user’s full name.
    • email (string). The user’s email address.
    • managerId (string). The manager’s ID.
    • isDisabled (boolean). States whether the user is active (false) or not (true).
    • isDeleted (boolean). States whether the user account was deleted (true) or not (false).
    • createdAt (string). The date and time of user account creation.
    • modifiedAt (string). The date and time of the last user account modification.
    • profile (object). The object includes basic user details: department, city, country, office, and so on.
    • externalReferences (array). The array includes the user account source (for example, AzureAD means the Microsoft Entra user account) and the details related to this source: ID, name, and metadata.
    • identity (string). The user’s identity.

 

Response example

The successful 200 response returns the body similar to this:


[
 {
   "delegateId": "c34b3379-3170-4462-607b-08de263288eb",
   "teamMemberId": "9e995999-31ee-4476-b15e-35309f369597",
   "isDeleted": false,
   "delegate": {
     "id": "c34b3379-3170-4462-607b-08de263288eb",
     "title": "Tyler Dunn",
     "email": null,
     "managerId": "7853ce01-9a6f-4e07-a3e0-1e3a578655d7",
     "isDisabled": false,
     "isDeleted": false,
     "createdAt": "2025-11-18T08:38:42.94",
     "modifiedAt": "2025-11-18T08:38:42.94",
     "profile": {
       "userId": "c34b3379-3170-4462-607b-08de263288eb",
       "department": null,
       "city": null,
       "country": null,
       "office": null,
       "jobTitle": null,
       "company": null,
       "phone": null,
       "firstName": "Tyler",
       "lastName": "Dunn",
       "hireDateTime": null,
       "createdAt": "2025-11-18T08:38:42.94",
       "modifiedAt": "2025-11-18T08:38:42.94"
     },
     "externalReferences": [
       {
         "userSource": "AzureAD",
         "externalId": "2a5d724b-d11c-494f-9361-8fce5e3b48cb",
         "externalName": "tdunn@compafi464.onmicrosoft.com",
         "metadata": "{\"PrincipalClaimPrefixType\":0}"
       }
     ],
     "identity": null
   },
   "teamMember": {
     "id": "9e995999-31ee-4476-b15e-35309f369597",
     "title": "Robert  Smith",
     "email": "rsmith@compafi464.onmicrosoft.com",
     "managerId": "4cf1a461-a435-4e80-8ac6-a2d4f0a7ef71",
     "isDisabled": false,
     "isDeleted": false,
     "createdAt": "2023-11-06T16:23:29.373",
     "modifiedAt": "2025-11-20T01:00:11.897",
     "profile": {
       "userId": "9e995999-31ee-4476-b15e-35309f369597",
       "department": "Talent Management and Development",
       "city": "Chicago",
       "country": "United States",
       "office": "Chicago",
       "jobTitle": "LMS Administrator",
       "company": null,
       "phone": null,
       "firstName": "Robert",
       "lastName": "Smith",
       "hireDateTime": null,
       "createdAt": "1900-01-01T00:00:00",
       "modifiedAt": "2025-10-30T13:32:04.6"
     },
     "externalReferences": [
       {
         "userSource": "AzureAD",
         "externalId": "1bd885a5-60cb-4756-a50b-1e2af04d98ca",
         "externalName": "rsmith@compafi464.onmicrosoft.com",
         "metadata": "{\"PrincipalClaimPrefixType\":0}"
       }
     ],
     "identity": null
   }
 }
]

 

Get a list of team members for a specific delegate

GET /services/users/v2/Delegates/{delegateId}/members

The request enables you to get a list of team members for a specific delegate.

 

Pre-conditions

To send the request, you'll need an API key.

To view a list of team members of a specific delegate, you’ll need the user ID of this delegate. To find this: 

1. Send the GET /services/users/v2/Delegates request.

2. In the response, find the delegateId of the required delegate.

 

Path parameter

  • delegateId (string). The user ID of a delegate.

 

Request example


GET /services/users/v2/Delegates/c34b3379-3170-4462-607b-08de263288eb/members

 

Response body parameters

The successful 200 response includes the same parameters as the response to the GET /services/users/v2/Delegates request.

 

Response example


[
 {
   "delegateId": "c34b3379-3170-4462-607b-08de263288eb",
   "teamMemberId": "9e995999-31ee-4476-b15e-35309f369597",
   "isDeleted": false,
   "delegate": {
     "id": "c34b3379-3170-4462-607b-08de263288eb",
     "title": "Tyler Dunn",
     "email": null,
     "managerId": "7853ce01-9a6f-4e07-a3e0-1e3a578655d7",
     "isDisabled": false,
     "isDeleted": false,
     "createdAt": "2025-11-18T08:38:42.94",
     "modifiedAt": "2025-11-18T08:38:42.94",
     "profile": {
       "userId": "c34b3379-3170-4462-607b-08de263288eb",
       "department": null,
       "city": null,
       "country": null,
       "office": null,
       "jobTitle": null,
       "company": null,
       "phone": null,
       "firstName": "Tyler",
       "lastName": "Dunn",
       "hireDateTime": null,
       "createdAt": "2025-11-18T08:38:42.94",
       "modifiedAt": "2025-11-18T08:38:42.94"
     },
     "externalReferences": [
       {
         "userSource": "AzureAD",
         "externalId": "2a5d724b-d11c-494f-9361-8fce5e3b48cb",
         "externalName": "tdunn@compafi464.onmicrosoft.com",
         "metadata": "{\"PrincipalClaimPrefixType\":0}"
       }
     ],
     "identity": null
   },
   "teamMember": {
     "id": "9e995999-31ee-4476-b15e-35309f369597",
     "title": "Robert  Smith",
     "email": "rsmith@compafi464.onmicrosoft.com",
     "managerId": "4cf1a461-a435-4e80-8ac6-a2d4f0a7ef71",
     "isDisabled": false,
     "isDeleted": false,
     "createdAt": "2023-11-06T16:23:29.373",
     "modifiedAt": "2025-11-20T01:00:11.897",
     "profile": null,
     "externalReferences": [],
     "identity": null
   }
 }
]

 

Was this article helpful?
0 out of 0 found this helpful

Comments

Article is closed for comments.