Manage customer accounts - Get customers

Service:

Partner Center Rest

API Version:

v1

Retrieves a segment of a partner's customers. Optional filtering of customers can also be applied. Customers can only be filtered by a string which their company name or domain name starts with. Full search is not supported currently. Customers can be filtered using a {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith} filter operation and specifying either: DisplayName (Company name) or DefaultDomainName as the filter field.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
version	path	True	string
filter.operator	query		integer int32
seekOperation	query		integer int32	The seek operation.
size	query		integer int32	The maximum number of customers to return.

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.Customer]	The request was successful. The response body contains a list of customers that match the filter. A continuation token is included if the response is paged by the page size. This token can be passed to /customers?seek= to seek customer results. 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.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

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.Customer]

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
items	Microsoft.Partner.Service.Customers.Contracts.V1.Customer[]
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.Address

Name	Type	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

Name	Type	Description
allowDelegatedAccess	boolean
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 microsoft_support none reseller syndication unknown
userCredentials	Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials

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

Name	Type	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

Name	Type	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

Name	Type	Description
password	System.Security.SecureString
userName	string

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

Name	Type	Description
key	string
value	string

System.Security.SecureString

Name	Type	Description
length	integer