Retrieve Microsoft Customer Agreements

GET /v1/Customers/mca

Bearer auth

Available to the roles: csp, reseller

Headers

X-Tenant string Required

The domain used to access the portal.
Authorization string Required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Default value is Bearer eyJ0eXAiO....
X-Correlation-Id string(uuid)

This header is optional and by setting it you can correlate the audit logs made by this request.

Query parameters

customerId string(uuid)

Optional GUID to filter by customer.
providerInstanceId string(uuid)

Optional GUID to filter by provider instance.
status string

Optional status to filter agreements. Valid values: required, linkgenerated, customeraccepted, linkexpired, agreementcreated (case insensitive).
searchValue string

Optional search value to filter by company name.
pageNumber integer(int32)

The page number for pagination.
pageSize integer(int32)

The page size for pagination.
sortPropertyName string

The property name to sort by. Valid values: CompanyName, Status. Default is Status.
excludeCompliant boolean

Whether we should retrieve agreements with agreementcreated status or not

Default value is false.
ascendingOrder boolean

Whether to sort in ascending order. Default is false (descending).

Default value is false.

Responses

200

text/plain

text/plain application/json text/json

OK
Hide response attributes Show response attributes object
- items array[object] | null
  
  The items for this page.
  
  Represents a Microsoft Customer Agreement (MCA) and its related presentation data.
  
  Hide items attributes Show items attributes object
  
  customerId string(uuid)
  
  Gets or sets the unique identifier of the customer.
  
  providerCustomerId string | null
  
  Gets or sets the provider-specific customer identifier associated with this MCA.
  
  companyName string | null
  
  Gets or sets the company name associated with the customer.
  
  providerInstanceId string(uuid)
  
  Gets or sets the unique identifier of the provider instance.
  
  providerInstanceName string | null
  
  Gets or sets the display name of the provider instance.
  
  firstName string | null
  
  Gets or sets the first name of the primary contact associated with this MCA.
  
  lastName string | null
  
  Gets or sets the last name of the primary contact associated with this MCA.
  
  email string | null
  
  Gets or sets the email address of the primary contact associated with this MCA.
  
  phone string | null
  
  Gets or sets the phone number of the primary contact associated with this MCA.
  
  status object
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
  
  attestationId string | null
  
  Gets or sets the attestation identifier associated with this MCA.
  
  lastUpdate string(date-time) | null
  
  Gets or sets the date and time of the most recent update to this MCA.
  
  dateAgreed string(date-time) | null
  
  Gets or sets the date and time when the MCA was agreed upon. This value is null unless the status is Microsoft.Domain.Customers.Enumerations.McaStatus.AgreementCreated.
  
  customer object
  
  View model that represents a customer.
  
  Additional properties are NOT allowed.
  
  Hide customer attributes Show customer attributes object
  
  id string(uuid)
  
  The GUID identifier for the customer.
  
  companyName string | null Required
  
  The name of the company. This may be up to 255 characters.
  
  taxId string | null
  
  The company tax Id. This may be up to 255 characters.
  
  country string | null Required
  
  The company country code in the ISO 3166-1 alpha-2 standard.
  
  addressLine1 string | null Required
  
  The company address line 1. This may be up to 255 characters.
  
  addressLine2 string | null
  
  The company address line 2. This may be up to 255 characters.
  
  city string | null Required
  
  The company city. This may be up to 255 characters.
  
  state string | null Required
  
  The company State. This may be up to 255 characters.
  
  zip string | null Required
  
  The company ZIP. This may be up to 30 characters.
  
  firstName string | null Required
  
  The company primary contact first name. This may be up to 255 characters.
  
  middleName string | null
  
  The company primary contact middle name. This may be up to 255 characters.
  
  lastName string | null Required
  
  The company primary contact last name. This may be up to 255 characters.
  
  email string | null Required
  
  The company primary contact email. This may be up to 255 characters.
  
  phone string | null Required
  
  The company primary contact phone. This may be up to 30 characters.
  
  internalIdentifier string | null
  
  The customer internal identifier. This may be up to 255 characters.
  
  resellerId string(uuid) | null
  
  The reseller identifier. If this value is set a relation between this customer and the reseller will be created, if null a direct relation between the CSP and the customer will be created instead.
  
  providerCustomers object | null Required
  
  The provider customers. A list containing the info about this customer in one or more provider instances.
  
  customerAssociations array[object] | null
  
  The list of partners associated to a customer
  
  The viewmodel for the customer relationships.
  
  Hide customerAssociations attributes Show customerAssociations attributes object
  
  resellerId string(uuid) | null
  
  The reseller id.
  
  name string | null
  
  The name of the partner.
  
  microsoftProviderCustomer object
  
  Represents a customer associated with a specific provider.
  
  Additional properties are NOT allowed.
  
  Hide microsoftProviderCustomer attributes Show microsoftProviderCustomer attributes object
  
  microsoftCustomerAgreement object
  
  Represents a Microsoft Customer Agreement (MCA) and its related presentation data.
  
  Additional properties are NOT allowed.
  
  providerName string | null
  
  The name of the provider associated with this customer. Possible values are 'Microsoft' and 'Generic'. This property is used for polymorphic JSON serialization.
  
  providerInstanceId string(uuid) Required
  
  The GUID identifier for the provider instance.
  
  providerCustomerId string | null
  
  The identifier for customer on the provider. This property will only be populated after a customer is successfully created on the provider.
  
  providerCustomerData string | null Required
  
  The provider specific data for this customer.
  
  margin object Required
  
  This value object contains the price margin for this entity.
  
  Additional properties are NOT allowed.
  
  Hide margin attributes Show margin attributes object
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Additional properties are NOT allowed.
  
  Hide marginRule attribute Show marginRule attribute object
  
  name string | null
  
  The name of the enumeration.
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
  
  offerTypeMargins object | null
  
  Contains as key the name of the offer type and as value the price margin applied to each offer type for this specific provider instance. Price margins applied at the offer type level will override the price margin applied at the provider instance level. If no price margin is applied to a specific offer type of this provider instance then it will not be in the dictionary. This dictionary is optional.
  
  Hide offerTypeMargins attribute Show offerTypeMargins attribute object | null
  
  * object
  
  This value object contains the price margin for this entity.
  
  Additional properties are NOT allowed.
  
  Hide * attributes Show * attributes object
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Additional properties are NOT allowed.
  
  Hide marginRule attribute Show marginRule attribute object
  
  name string | null
  
  The name of the enumeration.
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
  
  status object
  
  The status for this entity. Possible values: Processing, Success, Failed
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
  
  customerCreationError object
  
  The creation error for this provider customer. This property will only have a diferent value than None if the Status is equal to Failed. Possible values: DomainExists, InvalidCompanyInfo, None or Unknown
  
  Additional properties are NOT allowed.
  
  Hide customerCreationError attribute Show customerCreationError attribute object
  
  name string | null
  
  The name of the enumeration.
- paginationParameters object
  
  A model that is used to encapsulate the parameters needed to perform pagination queries.
  
  Additional properties are NOT allowed.
  
  Hide paginationParameters attributes Show paginationParameters attributes object
  
  pageNumber integer(int32)
  
  Indicates the number of the current page.
  
  pageSize integer(int32)
  
  The number of items that should be returned at most per page.
- totalPages integer(int32)
  
  The total number of pages available for the specified parameters and page size.
- totalCount integer(int32)
  
  The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.
- hasPreviousPage boolean
  
  Indicates if there is a previous page.
- hasNextPage boolean
  
  Indicates if there is a next page.
- continuationToken string | null
  
  The token to continue to retrieve the paginated items.
Hide response attributes Show response attributes object
- items array[object] | null
  
  The items for this page.
  
  Represents a Microsoft Customer Agreement (MCA) and its related presentation data.
  
  Hide items attributes Show items attributes object
  
  customerId string(uuid)
  
  Gets or sets the unique identifier of the customer.
  
  providerCustomerId string | null
  
  Gets or sets the provider-specific customer identifier associated with this MCA.
  
  companyName string | null
  
  Gets or sets the company name associated with the customer.
  
  providerInstanceId string(uuid)
  
  Gets or sets the unique identifier of the provider instance.
  
  providerInstanceName string | null
  
  Gets or sets the display name of the provider instance.
  
  firstName string | null
  
  Gets or sets the first name of the primary contact associated with this MCA.
  
  lastName string | null
  
  Gets or sets the last name of the primary contact associated with this MCA.
  
  email string | null
  
  Gets or sets the email address of the primary contact associated with this MCA.
  
  phone string | null
  
  Gets or sets the phone number of the primary contact associated with this MCA.
  
  status object
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
  
  attestationId string | null
  
  Gets or sets the attestation identifier associated with this MCA.
  
  lastUpdate string(date-time) | null
  
  Gets or sets the date and time of the most recent update to this MCA.
  
  dateAgreed string(date-time) | null
  
  Gets or sets the date and time when the MCA was agreed upon. This value is null unless the status is Microsoft.Domain.Customers.Enumerations.McaStatus.AgreementCreated.
  
  customer object
  
  View model that represents a customer.
  
  Additional properties are NOT allowed.
  
  Hide customer attributes Show customer attributes object
  
  id string(uuid)
  
  The GUID identifier for the customer.
  
  companyName string | null Required
  
  The name of the company. This may be up to 255 characters.
  
  taxId string | null
  
  The company tax Id. This may be up to 255 characters.
  
  country string | null Required
  
  The company country code in the ISO 3166-1 alpha-2 standard.
  
  addressLine1 string | null Required
  
  The company address line 1. This may be up to 255 characters.
  
  addressLine2 string | null
  
  The company address line 2. This may be up to 255 characters.
  
  city string | null Required
  
  The company city. This may be up to 255 characters.
  
  state string | null Required
  
  The company State. This may be up to 255 characters.
  
  zip string | null Required
  
  The company ZIP. This may be up to 30 characters.
  
  firstName string | null Required
  
  The company primary contact first name. This may be up to 255 characters.
  
  middleName string | null
  
  The company primary contact middle name. This may be up to 255 characters.
  
  lastName string | null Required
  
  The company primary contact last name. This may be up to 255 characters.
  
  email string | null Required
  
  The company primary contact email. This may be up to 255 characters.
  
  phone string | null Required
  
  The company primary contact phone. This may be up to 30 characters.
  
  internalIdentifier string | null
  
  The customer internal identifier. This may be up to 255 characters.
  
  resellerId string(uuid) | null
  
  The reseller identifier. If this value is set a relation between this customer and the reseller will be created, if null a direct relation between the CSP and the customer will be created instead.
  
  providerCustomers object | null Required
  
  The provider customers. A list containing the info about this customer in one or more provider instances.
  
  customerAssociations array[object] | null
  
  The list of partners associated to a customer
  
  The viewmodel for the customer relationships.
  
  Hide customerAssociations attributes Show customerAssociations attributes object
  
  resellerId string(uuid) | null
  
  The reseller id.
  
  name string | null
  
  The name of the partner.
  
  microsoftProviderCustomer object
  
  Represents a customer associated with a specific provider.
  
  Additional properties are NOT allowed.
  
  Hide microsoftProviderCustomer attributes Show microsoftProviderCustomer attributes object
  
  microsoftCustomerAgreement object
  
  Represents a Microsoft Customer Agreement (MCA) and its related presentation data.
  
  Additional properties are NOT allowed.
  
  providerName string | null
  
  The name of the provider associated with this customer. Possible values are 'Microsoft' and 'Generic'. This property is used for polymorphic JSON serialization.
  
  providerInstanceId string(uuid) Required
  
  The GUID identifier for the provider instance.
  
  providerCustomerId string | null
  
  The identifier for customer on the provider. This property will only be populated after a customer is successfully created on the provider.
  
  providerCustomerData string | null Required
  
  The provider specific data for this customer.
  
  margin object Required
  
  This value object contains the price margin for this entity.
  
  Additional properties are NOT allowed.
  
  Hide margin attributes Show margin attributes object
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Additional properties are NOT allowed.
  
  Hide marginRule attribute Show marginRule attribute object
  
  name string | null
  
  The name of the enumeration.
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
  
  offerTypeMargins object | null
  
  Contains as key the name of the offer type and as value the price margin applied to each offer type for this specific provider instance. Price margins applied at the offer type level will override the price margin applied at the provider instance level. If no price margin is applied to a specific offer type of this provider instance then it will not be in the dictionary. This dictionary is optional.
  
  Hide offerTypeMargins attribute Show offerTypeMargins attribute object | null
  
  * object
  
  This value object contains the price margin for this entity.
  
  Additional properties are NOT allowed.
  
  Hide * attributes Show * attributes object
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Additional properties are NOT allowed.
  
  Hide marginRule attribute Show marginRule attribute object
  
  name string | null
  
  The name of the enumeration.
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
  
  status object
  
  The status for this entity. Possible values: Processing, Success, Failed
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
  
  customerCreationError object
  
  The creation error for this provider customer. This property will only have a diferent value than None if the Status is equal to Failed. Possible values: DomainExists, InvalidCompanyInfo, None or Unknown
  
  Additional properties are NOT allowed.
  
  Hide customerCreationError attribute Show customerCreationError attribute object
  
  name string | null
  
  The name of the enumeration.
- paginationParameters object
  
  A model that is used to encapsulate the parameters needed to perform pagination queries.
  
  Additional properties are NOT allowed.
  
  Hide paginationParameters attributes Show paginationParameters attributes object
  
  pageNumber integer(int32)
  
  Indicates the number of the current page.
  
  pageSize integer(int32)
  
  The number of items that should be returned at most per page.
- totalPages integer(int32)
  
  The total number of pages available for the specified parameters and page size.
- totalCount integer(int32)
  
  The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.
- hasPreviousPage boolean
  
  Indicates if there is a previous page.
- hasNextPage boolean
  
  Indicates if there is a next page.
- continuationToken string | null
  
  The token to continue to retrieve the paginated items.
Hide response attributes Show response attributes object
- items array[object] | null
  
  The items for this page.
  
  Represents a Microsoft Customer Agreement (MCA) and its related presentation data.
  
  Hide items attributes Show items attributes object
  
  customerId string(uuid)
  
  Gets or sets the unique identifier of the customer.
  
  providerCustomerId string | null
  
  Gets or sets the provider-specific customer identifier associated with this MCA.
  
  companyName string | null
  
  Gets or sets the company name associated with the customer.
  
  providerInstanceId string(uuid)
  
  Gets or sets the unique identifier of the provider instance.
  
  providerInstanceName string | null
  
  Gets or sets the display name of the provider instance.
  
  firstName string | null
  
  Gets or sets the first name of the primary contact associated with this MCA.
  
  lastName string | null
  
  Gets or sets the last name of the primary contact associated with this MCA.
  
  email string | null
  
  Gets or sets the email address of the primary contact associated with this MCA.
  
  phone string | null
  
  Gets or sets the phone number of the primary contact associated with this MCA.
  
  status object
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
  
  attestationId string | null
  
  Gets or sets the attestation identifier associated with this MCA.
  
  lastUpdate string(date-time) | null
  
  Gets or sets the date and time of the most recent update to this MCA.
  
  dateAgreed string(date-time) | null
  
  Gets or sets the date and time when the MCA was agreed upon. This value is null unless the status is Microsoft.Domain.Customers.Enumerations.McaStatus.AgreementCreated.
  
  customer object
  
  View model that represents a customer.
  
  Additional properties are NOT allowed.
  
  Hide customer attributes Show customer attributes object
  
  id string(uuid)
  
  The GUID identifier for the customer.
  
  companyName string | null Required
  
  The name of the company. This may be up to 255 characters.
  
  taxId string | null
  
  The company tax Id. This may be up to 255 characters.
  
  country string | null Required
  
  The company country code in the ISO 3166-1 alpha-2 standard.
  
  addressLine1 string | null Required
  
  The company address line 1. This may be up to 255 characters.
  
  addressLine2 string | null
  
  The company address line 2. This may be up to 255 characters.
  
  city string | null Required
  
  The company city. This may be up to 255 characters.
  
  state string | null Required
  
  The company State. This may be up to 255 characters.
  
  zip string | null Required
  
  The company ZIP. This may be up to 30 characters.
  
  firstName string | null Required
  
  The company primary contact first name. This may be up to 255 characters.
  
  middleName string | null
  
  The company primary contact middle name. This may be up to 255 characters.
  
  lastName string | null Required
  
  The company primary contact last name. This may be up to 255 characters.
  
  email string | null Required
  
  The company primary contact email. This may be up to 255 characters.
  
  phone string | null Required
  
  The company primary contact phone. This may be up to 30 characters.
  
  internalIdentifier string | null
  
  The customer internal identifier. This may be up to 255 characters.
  
  resellerId string(uuid) | null
  
  The reseller identifier. If this value is set a relation between this customer and the reseller will be created, if null a direct relation between the CSP and the customer will be created instead.
  
  providerCustomers object | null Required
  
  The provider customers. A list containing the info about this customer in one or more provider instances.
  
  customerAssociations array[object] | null
  
  The list of partners associated to a customer
  
  The viewmodel for the customer relationships.
  
  Hide customerAssociations attributes Show customerAssociations attributes object
  
  resellerId string(uuid) | null
  
  The reseller id.
  
  name string | null
  
  The name of the partner.
  
  microsoftProviderCustomer object
  
  Represents a customer associated with a specific provider.
  
  Additional properties are NOT allowed.
  
  Hide microsoftProviderCustomer attributes Show microsoftProviderCustomer attributes object
  
  microsoftCustomerAgreement object
  
  Represents a Microsoft Customer Agreement (MCA) and its related presentation data.
  
  Additional properties are NOT allowed.
  
  providerName string | null
  
  The name of the provider associated with this customer. Possible values are 'Microsoft' and 'Generic'. This property is used for polymorphic JSON serialization.
  
  providerInstanceId string(uuid) Required
  
  The GUID identifier for the provider instance.
  
  providerCustomerId string | null
  
  The identifier for customer on the provider. This property will only be populated after a customer is successfully created on the provider.
  
  providerCustomerData string | null Required
  
  The provider specific data for this customer.
  
  margin object Required
  
  This value object contains the price margin for this entity.
  
  Additional properties are NOT allowed.
  
  Hide margin attributes Show margin attributes object
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Additional properties are NOT allowed.
  
  Hide marginRule attribute Show marginRule attribute object
  
  name string | null
  
  The name of the enumeration.
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
  
  offerTypeMargins object | null
  
  Contains as key the name of the offer type and as value the price margin applied to each offer type for this specific provider instance. Price margins applied at the offer type level will override the price margin applied at the provider instance level. If no price margin is applied to a specific offer type of this provider instance then it will not be in the dictionary. This dictionary is optional.
  
  Hide offerTypeMargins attribute Show offerTypeMargins attribute object | null
  
  * object
  
  This value object contains the price margin for this entity.
  
  Additional properties are NOT allowed.
  
  Hide * attributes Show * attributes object
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Additional properties are NOT allowed.
  
  Hide marginRule attribute Show marginRule attribute object
  
  name string | null
  
  The name of the enumeration.
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
  
  status object
  
  The status for this entity. Possible values: Processing, Success, Failed
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
  
  customerCreationError object
  
  The creation error for this provider customer. This property will only have a diferent value than None if the Status is equal to Failed. Possible values: DomainExists, InvalidCompanyInfo, None or Unknown
  
  Additional properties are NOT allowed.
  
  Hide customerCreationError attribute Show customerCreationError attribute object
  
  name string | null
  
  The name of the enumeration.
- paginationParameters object
  
  A model that is used to encapsulate the parameters needed to perform pagination queries.
  
  Additional properties are NOT allowed.
  
  Hide paginationParameters attributes Show paginationParameters attributes object
  
  pageNumber integer(int32)
  
  Indicates the number of the current page.
  
  pageSize integer(int32)
  
  The number of items that should be returned at most per page.
- totalPages integer(int32)
  
  The total number of pages available for the specified parameters and page size.
- totalCount integer(int32)
  
  The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.
- hasPreviousPage boolean
  
  Indicates if there is a previous page.
- hasNextPage boolean
  
  Indicates if there is a next page.
- continuationToken string | null
  
  The token to continue to retrieve the paginated items.
400

text/plain

text/plain application/json text/json

Bad Request
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
401

Unauthorized
403

Forbidden
500

text/plain

text/plain application/json text/json

Internal Server Error
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.

GET /v1/Customers/mca

curl \
 --request GET 'https://api.cloudcockpit.com/v1/Customers/mca' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"

Response examples (200)

{
  "items": [
    {
      "customerId": "string",
      "providerCustomerId": "string",
      "companyName": "string",
      "providerInstanceId": "string",
      "providerInstanceName": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string",
      "status": {
        "name": "string"
      },
      "attestationId": "string",
      "lastUpdate": "2025-05-04T09:42:00Z",
      "dateAgreed": "2025-05-04T09:42:00Z",
      "customer": {
        "id": "string",
        "companyName": "string",
        "taxId": "string",
        "country": "PT",
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "internalIdentifier": "string",
        "resellerId": "string",
        "providerCustomers": {
          "cb3cd15b-1d6e-45be-b493-c71549cbfd87": {
            "margin": {
              "value": 10.6,
              "marginRule": {
                "name": "markup"
              }
            },
            "providerName": "Microsoft",
            "offerTypeMargins": {
              "Value": {
                "license": {
                  "Value": 10,
                  "MarginRule": {
                    "Name": "markup"
                  }
                }
              }
            },
            "providerCustomerId": "f574cf12-a7d6-43fe-9663-1af97b04e5ab",
            "providerInstanceId": "cb3cd15b-1d6e-45be-b493-c71549cbfd87",
            "providerCustomerData": "{\"Domain\":\"TestDomain\",\"CredentialsEmail\":\"test@email.com\",\"AcceptedMCA\":true,\"AgreementDate\":\"2022-12-28T00:00:00Z\",\"KeepPrimaryInformation\":true,\"FirstName\":\"Test\",\"LastName\":\"Test\",\"Email\":\"test@email.com\",\"Phone\":\"921231231\",\"DefaultCulture\":\"en-US\",\"Language\":\"en\",\"AssociatedPartnerId\":null,\"Qualifications\":[],\"EnableGDAP\":true}",
            "microsoftCustomerAgreement": {
              "status": {
                "name": "required"
              },
              "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "dateAgreed": null,
              "lastUpdate": null,
              "attestationId": null,
              "signatoryContact": null,
              "providerInstanceId": "cb3cd15b-1d6e-45be-b493-c71549cbfd87"
            }
          }
        },
        "customerAssociations": [
          {
            "resellerId": "string",
            "name": "string"
          }
        ]
      },
      "microsoftProviderCustomer": {
        "microsoftCustomerAgreement": {},
        "providerName": "string",
        "providerInstanceId": "string",
        "providerCustomerId": "string",
        "providerCustomerData": "string",
        "margin": {
          "marginRule": {
            "name": "string"
          },
          "value": 8
        },
        "offerTypeMargins": {
          "*": {
            "marginRule": {
              "name": "string"
            },
            "value": 8
          }
        },
        "status": {
          "name": "string"
        },
        "customerCreationError": {
          "name": "string"
        }
      }
    }
  ],
  "paginationParameters": {
    "pageNumber": 42,
    "pageSize": 42
  },
  "totalPages": 42,
  "totalCount": 42,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "continuationToken": "string"
}

Response examples (200)

{
  "items": [
    {
      "customerId": "string",
      "providerCustomerId": "string",
      "companyName": "string",
      "providerInstanceId": "string",
      "providerInstanceName": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string",
      "status": {
        "name": "string"
      },
      "attestationId": "string",
      "lastUpdate": "2025-05-04T09:42:00Z",
      "dateAgreed": "2025-05-04T09:42:00Z",
      "customer": {
        "id": "string",
        "companyName": "string",
        "taxId": "string",
        "country": "PT",
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "internalIdentifier": "string",
        "resellerId": "string",
        "providerCustomers": {
          "cb3cd15b-1d6e-45be-b493-c71549cbfd87": {
            "margin": {
              "value": 10.6,
              "marginRule": {
                "name": "markup"
              }
            },
            "providerName": "Microsoft",
            "offerTypeMargins": {
              "Value": {
                "license": {
                  "Value": 10,
                  "MarginRule": {
                    "Name": "markup"
                  }
                }
              }
            },
            "providerCustomerId": "f574cf12-a7d6-43fe-9663-1af97b04e5ab",
            "providerInstanceId": "cb3cd15b-1d6e-45be-b493-c71549cbfd87",
            "providerCustomerData": "{\"Domain\":\"TestDomain\",\"CredentialsEmail\":\"test@email.com\",\"AcceptedMCA\":true,\"AgreementDate\":\"2022-12-28T00:00:00Z\",\"KeepPrimaryInformation\":true,\"FirstName\":\"Test\",\"LastName\":\"Test\",\"Email\":\"test@email.com\",\"Phone\":\"921231231\",\"DefaultCulture\":\"en-US\",\"Language\":\"en\",\"AssociatedPartnerId\":null,\"Qualifications\":[],\"EnableGDAP\":true}",
            "microsoftCustomerAgreement": {
              "status": {
                "name": "required"
              },
              "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "dateAgreed": null,
              "lastUpdate": null,
              "attestationId": null,
              "signatoryContact": null,
              "providerInstanceId": "cb3cd15b-1d6e-45be-b493-c71549cbfd87"
            }
          }
        },
        "customerAssociations": [
          {
            "resellerId": "string",
            "name": "string"
          }
        ]
      },
      "microsoftProviderCustomer": {
        "microsoftCustomerAgreement": {},
        "providerName": "string",
        "providerInstanceId": "string",
        "providerCustomerId": "string",
        "providerCustomerData": "string",
        "margin": {
          "marginRule": {
            "name": "string"
          },
          "value": 8
        },
        "offerTypeMargins": {
          "*": {
            "marginRule": {
              "name": "string"
            },
            "value": 8
          }
        },
        "status": {
          "name": "string"
        },
        "customerCreationError": {
          "name": "string"
        }
      }
    }
  ],
  "paginationParameters": {
    "pageNumber": 42,
    "pageSize": 42
  },
  "totalPages": 42,
  "totalCount": 42,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "continuationToken": "string"
}

Response examples (400)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (400)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (500)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (500)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}