List delegates

Article
2025-04-30

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get a list of all delegates for a user.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	CallDelegation.Read	CallDelegation.ReadWrite
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

HTTP request

To list all delegates for the signed-in user (/me) or a specific user (/users/{userId}/):

GET /me/communications/callSettings/delegates
GET /users/{userId}/communications/callSettings/delegates

Optional query parameters

This method supports the filter and count OData query parameters to help customize the response. For general information, see OData query parameters.

Scenario	Parameter	Example
Get the delegates who granted the signed-in user permission to receive calls.	`$filter`	`GET /me/communications/callSettings/delegates?$filter=allowedActions/receiveCalls eq true`
Get the number of delegates configured for the signed-in user.	`$count`	`GET /me/communications/callSettings/delegates?$count=true`

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of delegationSettings objects in the response body.

Examples

Example 1: Get all delegates

The following example shows how to get all delegates for the signed-in user (me).

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/me/communications/callSettings/delegates


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Communications.CallSettings.Delegates.GetAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



mgc-beta users communications call-settings delegates list --user-id {user-id}

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
delegates, err := graphClient.Me().Communications().CallSettings().Delegates().Get(context.Background(), nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DelegationSettingsCollectionResponse result = graphClient.me().communications().callSettings().delegates().get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let delegates = await client.api('/me/communications/callSettings/delegates')
	.version('beta')
	.get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->me()->communications()->callSettings()->delegates()->get()->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.me.communications.call_settings.delegates.get()

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.delegationSettings",
      "id": "62de48e1-a72c-40db-9193-a3bd8cf167c9",
      "createdDateTime": "2025-01-01T00:00:00Z",
      "isActive": true,
      "allowedActions": {
        "@odata.type": "microsoft.graph.delegateAllowedActions",
        "makeCalls": true,
        "receiveCalls": true,
        "manageCallAndDelegateSettings": true,
        "pickUpHeldCalls": true,
        "joinActiveCalls": false
      }
    },
    {
      "@odata.type": "#microsoft.graph.delegationSettings",
      "id": "739cfec7-7956-409a-a1c8-a76daab23c2a",
      "createdDateTime": "2025-02-01T00:00:00Z",
      "isActive": true,
      "allowedActions": {
        "@odata.type": "microsoft.graph.delegateAllowedActions",
        "makeCalls": false,
        "receiveCalls": true,
        "manageCallAndDelegateSettings": true,
        "pickUpHeldCalls": true,
        "joinActiveCalls": false
      }
    }
  ]
}

Example 2: Get all delegates who are able to receive calls

The following example shows how to get all delegates who are able to receive calls.

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/me/communications/callSettings/delegates?filter=allowedActions/receiveCalls eq true


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Communications.CallSettings.Delegates.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Filter = "allowedActions/receiveCalls eq true";
});

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



mgc-beta users communications call-settings delegates list --user-id {user-id}

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphusers "github.com/microsoftgraph/msgraph-beta-sdk-go/users"
	  //other-imports
)


requestFilter := "allowedActions/receiveCalls eq true"

requestParameters := &graphusers.CommunicationsCallSettingsDelegatesRequestBuilderGetQueryParameters{
	Filter: &requestFilter,
}
configuration := &graphusers.CommunicationsCallSettingsDelegatesRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
delegates, err := graphClient.Me().Communications().CallSettings().Delegates().Get(context.Background(), configuration)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DelegationSettingsCollectionResponse result = graphClient.me().communications().callSettings().delegates().get(requestConfiguration -> {
	requestConfiguration.queryParameters.filter = "allowedActions/receiveCalls eq true";
});

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

let delegates = await client.api('/me/communications/callSettings/delegates?filter=allowedActions/receiveCalls eq true')
	.version('beta')
	.filter('allowedActions/receiveCalls eq true')
	.get();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Users\Item\Communications\CallSettings\Delegates\DelegatesRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new DelegatesRequestBuilderGetRequestConfiguration();
$queryParameters = DelegatesRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "allowedActions/receiveCalls eq true";
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->me()->communications()->callSettings()->delegates()->get($requestConfiguration)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.users.item.communications.call_settings.delegates.delegates_request_builder import DelegatesRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = DelegatesRequestBuilder.DelegatesRequestBuilderGetQueryParameters(
		filter = "allowedActions/receiveCalls eq true",
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.me.communications.call_settings.delegates.get(request_configuration = request_configuration)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.delegationSettings",
      "id": "62de48e1-a72c-40db-9193-a3bd8cf167c9",
      "createdDateTime": "2025-01-01T00:00:00Z",
      "isActive": true,
      "allowedActions": {
        "@odata.type": "microsoft.graph.delegateAllowedActions",
        "makeCalls": true,
        "receiveCalls": true,
        "manageCallAndDelegateSettings": true,
        "pickUpHeldCalls": true,
        "joinActiveCalls": false
      }
    }
  ]
}

Share via

List delegates

Permissions

HTTP request

Optional query parameters

Request headers

Request body

Response

Examples

Example 1: Get all delegates

Request

Response

Example 2: Get all delegates who are able to receive calls

Request

Response

Feedback

Additional resources