Get locations

Retrieves the properties and relationships of a location object for Business Central.

HTTP request

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

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

Request headers

Request body

Don't supply a request body for this method.

Response

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

Example

Request

Here's an example of the request.

GET https://{businesscentralPrefix}/api/v2.0/companies({id})/locations({id})

Response

Here's an example of the response.

{
    "id": "59f029b1-508c-ed11-aada-000d3a298ab3",
    "code": "MAIN",
    "displayName": "Main Warehouse",
    "contact": "Eleanor Faulkner",
    "addressLine1": "UK Campus Bldg 5",
    "addressLine2": "Thames Valley Park",
    "city": "Reading",
    "state": "",
    "country": "GB",
    "postalCode": "RG6 1WG",
    "phoneNumber": "+44-(0)10 5214 4987",
    "email": "",
    "website": ""
}

Related information

Tips for working with the APIs
location
DELETE location
POST location
PATCH location