Manage customer accounts - Get agreements
Gets the agreement confirmations provided by a partner on behalf of a customer.
GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/agreements
GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/agreements?agreementType={agreementType}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
customer_id
|
path | True |
string |
Customer ID. |
version
|
path | True |
string |
|
agreement
|
query |
string |
The agreement type to filter the agreement confirmations on. '*' will return agreements of all types. The default, if not specified, is Microsoft Cloud Agreement (MCA). |
Request Header
Name | Required | Type | Description |
---|---|---|---|
Authorization | True |
string |
Authorization Bearer token |
ms-correlationid |
string |
Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request |
|
ms-cv |
string |
Used for tracking requests internally. If a ms-cv is not provided, the server will generate a new one for each request |
|
ms-requestid |
string |
Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Microsoft. |
The request was successful. The agreement is successfully retrieved. Media Types: "application/json", "text/json" |
Definitions
Name | Description |
---|---|
Microsoft. |
|
Microsoft. |
Microsoft.Partner.Service.Customers.Contracts.V1.Agreement
Name | Type | Description |
---|---|---|
agreementLink |
string |
|
dateAgreed |
string |
|
primaryContact | ||
templateId |
string |
|
type |
enum:
|
|
userId |
string |
Microsoft.Partner.Service.Customers.Contracts.V1.Contact
Name | Type | Description |
---|---|---|
string |
||
firstName |
string |
|
lastName |
string |
|
phoneNumber |
string |