Manage customer accounts - Get partner relationships

Service:

Partner Center Rest

API Version:

v1

Retrieves a segment of a partner's resellers. Optional filtering of partner relationships can also be applied. Resellers can only be filtered by a string which their name. Full search is not supported currently. Resellers can be filtered using a {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith} filter operation and specifying: Name (Value added reseller name) as the filter field.

GET https://api.partnercenter.microsoft.com/v{version}/relationships

With optional parameters:

GET https://api.partnercenter.microsoft.com/v{version}/relationships?relationship_type={relationship_type}&filter.operator={filter.operator}

URI Parameters

Name	In	Required	Type	Description
version	path	True	string
filter.operator	query		integer int32
relationship_type	query		integer int32	Type of the relationship.

Request Header

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

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.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.PartnerRelationship]	The request was successful. The response body contains the list of partner relationships. Media Types: "application/json", "text/json"

Definitions

Name	Description
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.PartnerRelationship]
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Service.Customers.Contracts.V1.PartnerRelationship
System.Collections.Generic.KeyValuePair[System.String,System.String]

Microsoft.Partner.Core.Collections.Link

Name	Type	Description
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

Microsoft.Partner.Core.Collections.ResourceAttributes

Name	Type	Description
etag	string
objectType	string

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.PartnerRelationship]

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
items	Microsoft.Partner.Service.Customers.Contracts.V1.PartnerRelationship[]
links	Microsoft.Partner.Core.Collections.ResourceLinks
totalCount	integer

Microsoft.Partner.Core.Collections.ResourceLinks

Name	Type	Description
next	Microsoft.Partner.Core.Collections.Link
previous	Microsoft.Partner.Core.Collections.Link
self	Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Service.Customers.Contracts.V1.PartnerRelationship

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
id	string
location	string
mpnId	string
name	string
relationshipType	enum: is_indirect_cloud_solution_provider_of is_indirect_reseller_of none
state	string

System.Collections.Generic.KeyValuePair[System.String,System.String]

Name	Type	Description
key	string
value	string