Edit

Share via

Get companies

Retrieve the properties and relationships of a companies object for Business Central.

HTTP request

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

GET businesscentralPrefix/companies

Request headers

Header Value
Authorization Bearer {token}. Required.

Request body

Don't supply a request body for this method.

Response

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

Example

Request

Here's an example of the request.

GET https://{businesscentralPrefix}/api/v2.0/companies

Response

Here's an example of the response.

Note

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

{
    "id": "824820a2-508c-ed11-aada-000d3a298ab3",
    "systemVersion": "21.2.49946.51685",
    "timestamp": 50516,
    "name": "CRONUS US",
    "displayName": "CRONUS USA, Inc.",
    "businessProfileId": "",
    "systemCreatedAt": "2023-01-04T16:55:47.367Z",
    "systemCreatedBy": "f2a5738a-44e3-ea11-bb43-000d3a2feca1",
    "systemModifiedAt": "2023-01-04T16:55:47.367Z",
    "systemModifiedBy": "f2a5738a-44e3-ea11-bb43-000d3a2feca1"
}

Tips for working with the APIs
company