Manage account profiles - Get organization profile

Gets the organization profile.

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

URI Parameters

Name In Required Type Description
version
path True

string

Api version.

Request Header

Name Required Type Description
Authorization True

string

Authorization Bearer token

Accept True

string

Acceptable content type; widely accepeted type application/json

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-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.Sdk.Contracts.V1.OrganizationProfile

The request was successful. The response body contains the organization profile.

Media Types: "application/json", "application/xml", "text/xml", "text/json"

400 Bad Request

There was a missing or an invalid input. The response body will provide the error details.

Media Types: "application/json", "application/xml", "text/xml", "text/json"

401 Unauthorized

The request was not authenticated. The client needs to authenticate with the partner API service first.

Media Types: "application/json", "application/xml", "text/xml", "text/json"

403 Forbidden

The request was authenticated but was refused since the caller does not have the rights to invoke it.

Media Types: "application/json", "application/xml", "text/xml", "text/json"

404 Not Found

The resource is not found or not available with the given input parameters.

Media Types: "application/json", "application/xml", "text/xml", "text/json"

500 Internal Server Error

The partner API service or one of its dependencies failed to fulfill the request. Callers may retry this.

Media Types: "application/json", "application/xml", "text/xml", "text/json"

Definitions

Name Description
Microsoft.Partner.Sdk.Contracts.V1.Address

Represents an address for a customer or partner.

Microsoft.Partner.Sdk.Contracts.V1.Common.Link

Link represents a URI and the HTTP method which indicates the desired action for accessing the resource.

Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes

Refers to the common object attributes

Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks

Navigation links for the resource

Microsoft.Partner.Sdk.Contracts.V1.OrganizationProfile

Describes a partner's organization profile.

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

Microsoft.Partner.Sdk.Contracts.V1.Address

Represents an address for a customer or partner.

Name Type Description
addressLine1

string

Gets or sets the first line of the address.

addressLine2

string

Gets or sets the second line of the address. This property is optional.

city

string

Gets or sets the city.

country

string

Gets or sets the country/region in ISO country code format.

firstName

string

Gets or sets the first name of a contact at the customer's company/organization.

lastName

string

Gets or sets the last name of a contact at the customer's company/organization.

phoneNumber

string

Gets or sets the phone number of a contact at the customer's company/organization. This property is optional.

postalCode

string

Gets or sets the ZIP code or postal code.

region

string

Gets or sets the region.

state

string

Gets or sets the state.

Link represents a URI and the HTTP method which indicates the desired action for accessing the resource.

Name Type Description
headers

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

Gets the link headers.

method

string

The method.

uri

string

The URI.

Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes

Refers to the common object attributes

Name Type Description
etag

string

Gets or sets the etag. The object version in providers.

objectType

string

The type of object.

Navigation links for the resource

Name Type Description
next

Microsoft.Partner.Sdk.Contracts.V1.Common.Link

The next page of items.

previous

Microsoft.Partner.Sdk.Contracts.V1.Common.Link

The previous page of items.

self

Microsoft.Partner.Sdk.Contracts.V1.Common.Link

The self uri.

Microsoft.Partner.Sdk.Contracts.V1.OrganizationProfile

Describes a partner's organization profile.

Name Type Description
attributes

Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes

Gets the attributes.

companyName

string

GEts or sets the name of the company or organization.

culture

string

Gets or sets the preferred culture for communication and currency, such as "en-us".

defaultAddress

Microsoft.Partner.Sdk.Contracts.V1.Address

Gets or sets the default address of the company or organization.

domain

string

Gets or sets the company or organization's domain.

email

string

Gets or sets the company or organization's email

id

string

Gets or sets the organization's identifier.

language

string

Gets or sets the preferred language for communication.

links

Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks

Gets or sets the links.

profileType enum:
  • billing_profile
  • legal_business_profile
  • mpn_profile
  • organization_profile
  • support_profile

Gets the partner profile type.

tenantId

string

Gets or sets the tenant identifier.

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

Name Type Description
key

string

value

string