Get orgContact

Article
11/06/2024

Namespace: microsoft.graph

Get the properties and relationships of an organizational contact.

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)	OrgContact.Read.All	Directory.Read.All, Directory.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	OrgContact.Read.All	Directory.Read.All, Directory.ReadWrite.All

Important

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

Directory Readers - read basic properties
Global Reader
Directory Writers
Intune Administrator
User Administrator

HTTP request

GET /contacts/{id}

Optional query parameters

This method supports the $select and $expand OData query parameters to help customize the response.

Request headers

Header	Value
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 an orgContact object in the response body.

Example

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/contacts/25caf6a2-d5cb-470d-8940-20ba795ef62d


// 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.Contacts["{orgContact-id}"].GetAsync();

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



mgc contacts get --org-contact-id {orgContact-id}

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 $v1.*

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


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
contacts, err := graphClient.Contacts().ByOrgContactId("orgContact-id").Get(context.Background(), nil)

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);

OrgContact result = graphClient.contacts().byOrgContactId("{orgContact-id}").get();

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 orgContact = await client.api('/contacts/25caf6a2-d5cb-470d-8940-20ba795ef62d')
	.get();

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


<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->contacts()->byOrgContactId('orgContact-id')->get()->wait();

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


Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgContact -OrgContactId $orgContactId

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 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.contacts.by_org_contact_id('orgContact-id').get()

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#contacts/$entity",
    "id": "25caf6a2-d5cb-470d-8940-20ba795ef62d",
    "deletedDateTime": null,
    "companyName": "Adatum Corporation",
    "department": null,
    "displayName": "Adele Vance",
    "proxyAddresses": [
        "SMTP:[email protected]"
    ],
    "givenName": "Adele",
    "imAddresses": [],
    "jobTitle": "Engagement manager",
    "mail": "[email protected]",
    "mailNickname": "AdeleVance",
    "onPremisesLastSyncDateTime": null,
    "onPremisesSyncEnabled": null,
    "surname": "Vance",
    "addresses": [
        {
            "city": null,
            "countryOrRegion": "United States",
            "officeLocation": null,
            "postalCode": null,
            "state": null,
            "street": null
        }
    ],
    "onPremisesProvisioningErrors": [],
    "phones": [
        {
            "number": null,
            "type": "businessFax"
        },
        {
            "number": null,
            "type": "mobile"
        },
        {
            "number": null,
            "type": "business"
        }
    ]
}

Share via

Get orgContact

Permissions

HTTP request

Optional query parameters

Request headers

Request body

Response

Example

Request

Response

Feedback

Additional resources