List Device Codes - Automate.ax

square.listDeviceCodes lists all DeviceCodes associated with the merchant.

Example

automations/square-list-device-codes.automation.ts

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

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

  square.listDeviceCodes({
    cursor: "cursor",
    locationId: "location_id",
    productType: "TERMINAL_API",
    status: "UNKNOWN",
  })
})

Inputs

Every input accepts a compatible signal. It requires DEVICE_CREDENTIAL_MANAGEMENT.

Field	Type	Required	Default	Description
`cursor`	`string \| null`	No	—	A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See Paginating results for more information.
`locationId`	`string \| null`	No	—	If specified, only returns DeviceCodes of the specified location. Returns DeviceCodes of all locations if empty.
`productType`	`Square.ProductType \| null`	No	—	If specified, only returns DeviceCodes targeting the specified product type. Returns DeviceCodes of all product types if empty.
`status`	`Square.DeviceCodeStatus \| null`	No	—	If specified, returns DeviceCodes with the specified statuses. Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.

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

Output

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