List Devices - Automate.ax

square.listDevices list devices associated with the merchant.

Example

automations/square-list-devices.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("List Square Devices", () => {
  onDashboardRun({ title: "List Square Devices" })

  square.listDevices({
    cursor: "cursor",
    sortOrder: "DESC",
    limit: 1,
    locationId: "location_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires DEVICES_READ.

Field	Type	Required	Default	Description
`cursor`	`string \| null`	No	—	A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. See Pagination for more information.
`sortOrder`	`Square.SortOrder \| null`	No	—	The order in which results are listed. - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).
`limit`	`number \| null`	No	—	The number of results to return in a single page.
`locationId`	`string \| null`	No	—	If present, only returns devices at the target location.

Use the official ListDevices reference for provider field semantics and limits.

Output

Returns the official Square.ListDevicesResponse response as a codec-safe object. Square integer money amounts remain bigint values.