Get customers

Retrieve the properties and relationships of a customer object for Dynamics 365 Business Central.

HTTP request

Replace the URL prefix for Dynamics 365 Business Central depending on environment following the guideline.

GET businesscentralPrefix/companies({id})/customers({id})

Request headers

Header Value
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.


If successful, this method returns a 200 OK response code and a customers object in the response body.


Here is an example of the request.

GET https://{businesscentralPrefix}/api/beta/companies({id})/customers({id})


Here is an example of the response.


The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

  "id": "id-value",
  "number": "10000",
  "displayName": "Coho Winery",
  "type": "Company",
  "address": {
    "street": "192 Market Square",
    "city": "Atlanta",
    "state": "GA",
    "countryLetterCode": "US",
    "postalCode": "31772"
  "phoneNumber": "",
  "email": "",
  "website": "",
  "taxLiable": true,
  "taxAreaId": "taxAreaId-value",
  "taxAreaDisplayName": "tax area",
  "taxRegistrationNumber": "28012001T",
  "currencyId": "currencyId-value",
  "currencyCode": "USD",
  "paymentTermsId": "3bb5b4b6-ea4c-43ca-ba1c-3b69e29a6668",
  "shipmentMethodId": "shipmentMethodId-value",
  "shipmentMethod": null,
  "paymentMethodId": "paymentMethodId-value",
  "paymentMethod": {
    "code": "BANK",
    "description": "Bank Transfer"
  "blocked": " ",
  "balance": 0,
  "overdueAmount": 0,
  "totalSalesExcludingTax": 0,
  "lastModifiedDateTime": "2017-03-07T00:35:28.983Z"

See also

Tips for working with the APIs
Working with Dynamics 365 Business Central in Microsoft Graph
Enabling the APIs for Dynamics 365 Business Central
Endpoints for the APIs
Error Codes
Post Customers
Patch Customers
Delete Customers