SpeedgateSpeedgate

Find Scanners

This endpoint retrieves a list of all scanners registered within the specified company.

Scanner Id Filter
The ScannerId parameter allows you to filter the list by scanner Id. It supports wildcards, enabling partial matches to retrieve multiple related scanners efficiently.

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-api-versiondateOptional

Used for API versioning. More details.

Query parameters

scannerIdstringRequired

A human friendly unique code that identifies a specific speedgate. Supports filtering such as * for wildcard matching f.ex. GATE*

Response

Returns a list of scanners according t .
scannerslist of objects
requireScannerIdboolean or null
Indicates if the speedgate requires a scanner id when scanning a reference number. When not providing a scanner id, a set of default profiles will be used for configuration.
permitTicketsboolean or null
Indicates if the scanner will permit tickets when scanned.
permitMemberCardsboolean or null
Indicates if the scanner will permit member cards when scanned.
permitWalletsboolean or null
Indicates if the scanner will permit wallets when scanned.
imageProfileCodestring or null
Code representing the image profile.
ticketProfileCodestring or null
Code representing the ticket profile.
memberCardProfileCodestring or null
Code representing the member card profile.
itemslist of objects or null