inventory

List inventory custom fields

GET

/v1/inventory/custom-fields

curl --request GET \
  --url https://api.beamdynamics.io/v1/inventory/custom-fields \
  --header 'beam-api-key: <api-key>'

{
  "currentPage": 123,
  "hasMore": true,
  "results": [
    {
      "createdAt": "<string>",
      "currencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "defaultValue": "<string>",
      "description": "<string>",
      "entityType": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isSearchable": true,
      "isUnique": true,
      "name": "<string>",
      "selectableValues": [
        {
          "customFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "order": 123,
          "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "value": "<string>"
        }
      ],
      "type": "text",
      "updatedAt": "<string>"
    }
  ],
  "total": 123,
  "totalPages": 123
}

Authorizations

beam-api-keystringheaderrequired

Response

Paginated list of custom fields

currentPagenumberrequired

hasMorebooleanrequired

resultsobject[]required

Show child attributes

totalnumberrequired

totalPagesnumberrequired

Still need help? Ask the team