Manage customer accounts - Get customers

Tjänst:

Partner Center Rest

API-version:

v1

Hämtar ett segment av en partners kunder. Valfri filtrering av kunder kan också användas. Kunder kan bara filtreras efter en sträng som deras företagsnamn eller domännamn börjar med. Fullständig sökning stöds inte för närvarande. Kunder kan filtreras med filteråtgärden {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith} och ange antingen: DisplayName (företagsnamn) eller DefaultDomainName som filterfält.

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

Med valfria parametrar:

GET https://api.partnercenter.microsoft.com/v{version}/customers?seekOperation={seekOperation}&size={size}&filter.operator={filter.operator}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
version	path	True	string
filter.operator	query		integer (int32)
seekOperation	query		integer (int32)	Sökåtgärden.
size	query		integer (int32)	Det maximala antalet kunder som ska returneras.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
Authorization	True	string	Token för auktoriseringsbärare
ms-correlationid		string	Används för att spåra begäranden internt. Om ett ms-correlationid inte anges genererar servern en ny för varje begäran
ms-cv		string	Används för att spåra begäranden internt. Om en ms-cv inte tillhandahålls genererar servern en ny för varje begäran
ms-requestid		string	Används för idempotens för begäranden. Om ett ms-requestid inte har angetts genererar servern en ny för varje begäran

Svar

Name	Typ	Description
200 OK	Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]	Begäran lyckades. Svarstexten innehåller en lista över kunder som matchar filtret. En fortsättningstoken inkluderas om svaret är sidformaterat. Den här token kan skickas till /customers?seek= för att söka efter kundresultat. Media Types: "application/json", "text/json"

Definitioner

Name	Description
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Service.Customers.Contracts.V1.Address
Microsoft.Partner.Service.Customers.Contracts.V1.Customer
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile
Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials
System.Collections.Generic.KeyValuePair[System.String,System.String]
System.Security.SecureString

Microsoft.Partner.Core.Collections.Link

Objekt

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

Microsoft.Partner.Core.Collections.ResourceAttributes

Objekt

Name	Typ	Description
etag	string
objectType	string

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

Objekt

Name	Typ	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
items	Microsoft.Partner.Service.Customers.Contracts.V1.Customer[]
links	Microsoft.Partner.Core.Collections.ResourceLinks
totalCount	integer (int32)

Microsoft.Partner.Core.Collections.ResourceLinks

Objekt

Name	Typ	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.Address

Objekt

Name	Typ	Description
addressLine1	string
addressLine2	string
addressLine3	string
city	string
country	string
district	string
emailAddress	string
firstName	string
id	string
lastName	string
middleName	string
phoneNumber	string
postalCode	string
region	string
state	string

Microsoft.Partner.Service.Customers.Contracts.V1.Customer

Objekt

Name	Typ	Description
allowDelegatedAccess	bool?
associatedPartnerId	string
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
billingProfile	Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile
commerceId	string
companyProfile	Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile
customDomains	string[]
id	string
links	Microsoft.Partner.Core.Collections.ResourceLinks
relationshipToPartner	enum: advisor (int32) microsoft_support (int32) none (int32) reseller (int32) syndication (int32) unknown (int32)
userCredentials	Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile

Objekt

Name	Typ	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
companyName	string
culture	string
defaultAddress	Microsoft.Partner.Service.Customers.Contracts.V1.Address
email	string
firstName	string
id	string
language	string
lastName	string
links	Microsoft.Partner.Core.Collections.ResourceLinks

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile

Objekt

Name	Typ	Description
address	Microsoft.Partner.Service.Customers.Contracts.V1.Address
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
companyName	string
domain	string
email	string
links	Microsoft.Partner.Core.Collections.ResourceLinks
organizationRegistrationNumber	string
tenantId	string

Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials

Objekt

Name	Typ	Description
password	System.Security.SecureString
userName	string

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

Objekt

Name	Typ	Description
key	string
value	string

System.Security.SecureString

Objekt

Name	Typ	Description
length	integer (int32)