List Channels - Automate.ax

square.listChannels listChannels.

Example

automations/square-list-channels.automation.ts

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

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

  square.listChannels({
    referenceType: "UNKNOWN_TYPE",
    referenceId: "reference_id",
    status: "ACTIVE",
    cursor: "cursor",
    limit: 1,
  })
})

Inputs

Every input accepts a compatible signal. It requires CHANNELS_READ.

Field	Type	Required	Default	Description
`referenceType`	`Square.ReferenceType \| null`	No	—	Type of reference associated to channel
`referenceId`	`string \| null`	No	—	id of reference associated to channel
`status`	`Square.ChannelStatus \| null`	No	—	Status of channel
`cursor`	`string \| null`	No	—	Cursor to fetch the next result
`limit`	`number \| null`	No	—	Maximum number of results to return. When not provided the returned results will be cap at 100 channels.

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

Output

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