List contracts

• 5/31/2019
• 2 minutes to read
• Contributors
  • 
  • 
  • 
  • 

Retrieve a list of contract objects associated to a partner tenant.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

HTTP request

GET /contracts

Optional query parameters

This method supports the OData Query Parameters to help customize the response.

Filtering is supported for customerId, defaultDomainName, and displayName.

Request headers

Request body

Do not supply a request body for this method.

Response

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

Example

Request

GET https://graph.microsoft.com/v1.0/contracts

Response

Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
    "value": [
    {
      "contractType": "contractType-value",
      "customerId": "customerId-value",
      "defaultDomainName": "defaultDomainName-value",
      "displayName": "displayName-value",
      "id": "id-value"
    }
  ]
}

SDK sample code

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var contracts = await graphClient.Contracts
	.Request()
	.GetAsync();

const options = {
	authProvider,
};

const client = Client.init(options);

let res = await client.api('/contracts')
	.get();

Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.