List Items

Returns a list of items

GET/companies({company_id})/items

Use it in a workflow

Add a step and choose the Microsoft Dynamics 365 Business Central connector.
Pick the List Items action (under Business Central).
Fill in the fields below, then reference the result from later steps as {{listItems.response.data}}.

Request

Path parameters

company_idstring (uuid)required

(v1.0) id for company

Query parameters

$topinteger

(v1.0) Number of items to return from the top of the list

$skipinteger

(v1.0) Number of items to skip from the list

$limitinteger

(v1.0) Number of items to return from the list

$filterstring

(v1.0) Filtering expression

$expandarray<string>

(v1.0) Entities to expand

$selectarray<string>

(v1.0) Selected properties to be retrieved

Response

Returns 200 with an object. Read it in later steps with {{listItems.response.data.<field>}}.

valuearray<object>

idstring (uuid)

(v1.0) The id property for the Dynamics 365 Business Central item entity

numberstring

(v1.0) The number property for the Dynamics 365 Business Central item entity

displayNamestring

(v1.0) The displayName property for the Dynamics 365 Business Central item entity

typestring

(v1.0) The type property for the Dynamics 365 Business Central item entity

itemCategoryIdstring (uuid)

(v1.0) The itemCategoryId property for the Dynamics 365 Business Central item entity

itemCategoryCodestring

(v1.0) The itemCategoryCode property for the Dynamics 365 Business Central item entity

blockedboolean

(v1.0) The blocked property for the Dynamics 365 Business Central item entity

baseUnitOfMeasureIdstring (uuid)

(v1.0) The baseUnitOfMeasureId property for the Dynamics 365 Business Central item entity

baseUnitOfMeasureobject7 fields

gtinstring

(v1.0) The gtin property for the Dynamics 365 Business Central item entity

inventorynumber (decimal)

(v1.0) The inventory property for the Dynamics 365 Business Central item entity

unitPricenumber (decimal)

(v1.0) The unitPrice property for the Dynamics 365 Business Central item entity

priceIncludesTaxboolean

(v1.0) The priceIncludesTax property for the Dynamics 365 Business Central item entity

unitCostnumber (decimal)

(v1.0) The unitCost property for the Dynamics 365 Business Central item entity

taxGroupIdstring (uuid)

(v1.0) The taxGroupId property for the Dynamics 365 Business Central item entity

taxGroupCodestring

(v1.0) The taxGroupCode property for the Dynamics 365 Business Central item entity

lastModifiedDateTimestring (date-time)

(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central item entity

picturearray<object>6 fields

defaultDimensionsarray<object>9 fields

itemCategoryobject4 fields

json

{
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "number": "string",
      "displayName": "string",
      "type": "string",
      "itemCategoryId": "00000000-0000-0000-0000-000000000000",
      "itemCategoryCode": "string",
      "blocked": false,
      "baseUnitOfMeasureId": "00000000-0000-0000-0000-000000000000",
      "baseUnitOfMeasure": {
        "code": "string",
        "displayName": "string",
        "symbol": "string",
        "unitConversion": {
          "toUnitOfMeasure": "string",
          "fromToConversionRate": 0,
          "picture": [
            {
              "id": null,
              "width": null,
              "height": null,
              "contentType": null,
              "content@odata.mediaEditLink": null,
              "content@odata.mediaReadLink": null
            }
          ],
          "defaultDimensions": [
            {
              "parentId": null,
              "dimensionId": null,
              "dimensionCode": null,
              "dimensionValueId": null,
              "dimensionValueCode": null,
              "postingValidation": null,
              "account": null,
              "dimension": null,
              "dimensionValue": null
            }
          ],
          "itemCategory": {
            "id": "00000000-0000-0000-0000-000000000000",
            "code": "string",
            "displayName": "string",
            "lastModifiedDateTime": "2025-01-01T00:00:00Z"
          }
        },
        "picture": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "width": 0,
            "height": 0,
            "contentType": "string",
            "content@odata.mediaEditLink": "string",
            "content@odata.mediaReadLink": "string"
          }
        ],
        "defaultDimensions": [
          {
            "parentId": "00000000-0000-0000-0000-000000000000",
            "dimensionId": "00000000-0000-0000-0000-000000000000",
            "dimensionCode": "string",
            "dimensionValueId": "00000000-0000-0000-0000-000000000000",
            "dimensionValueCode": "string",
            "postingValidation": "string",
            "account": {},
            "dimension": {},
            "dimensionValue": {}
          }
        ],
        "itemCategory": {
          "id": "00000000-0000-0000-0000-000000000000",
          "code": "string",
          "displayName": "string",
          "lastModifiedDateTime": "2025-01-01T00:00:00Z"
        }
      },
      "gtin": "string",
      "inventory": 0,
      "unitPrice": 0
    }
  ]
}

Need more? See the Microsoft Dynamics 365 Business Central guide for connection setup and behaviour shared by every action.

Was this page helpful?