GDAP API: Get Relationships


This article is describing our current GDAP API endpoint parameters, payloads and which call methods to use for specific tasks, and how to combine these workflows in C# implementation for GDAP Relationship Listing flow.

Resource Links

Swagger UI -

Base URL:


API: Lists Current GDAP Relationships
Method: GET


Key Value Description
providerId 918c6a1a-******-e0343eea7e0b Microsoft Partner Tenant Id



Key Value Description
Authorization Bearer {accesstoken} Your access token here

GET -*******-e0343eea7e0b

JSON Response 1 (If access is valid and the account has permissions) :

    "value": [
            "customer": {
            "accessDetails": {
                "unifiedRoles": [

JSON Response 2 (If the access token is not valid or lacks permissions for the call):


Response type will default to - 401 (Unauthorized)

C# Method Example:

public async Task<string> GetGdapRelationships(string baseUrl, string providerId, string bearer)
string uri = $"{baseUrl}GetRelationships?providerId={providerId}";
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(uri);
request.Method = "GET";
request.Headers.Add("Authorization", $"Bearer {bearer}");
request.Accept = "application/json";
request.ContentType = "application/json";
request.Expect = "application/json";

using (HttpWebResponse response = (HttpWebResponse)await request.GetResponseAsync())
using (Stream stream = response.GetResponseStream())
using (StreamReader reader = new StreamReader(stream))
return await reader.ReadToEndAsync();


Calling this method from code:

var getCurrentRelationships = await gdapTemplateOps.GetGdapRelationships(CurrentBaseUrl, "ProviderIdhere", bearerToken.access_token);

Was this article helpful?

0 out of 0 found this helpful

Add comment

Please sign in to leave a comment.