Search Terminal Actions - Automate.ax

square.searchTerminalActions retrieves a filtered list of Terminal action requests created by the account making the request.

Example

automations/square-search-terminal-actions.automation.ts

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

export default automation("Search Square Terminal Actions", () => {
  onDashboardRun({ title: "Search Square Terminal Actions" })

  square.searchTerminalActions({
    query: {
      filter: {
        createdAt: {
          startAt: "2022-04-01T00:00:00.000Z",
        },
      },
      sort: {
        sortOrder: "DESC",
      },
    },
    limit: 2,
  })
})

Inputs

Every input accepts a compatible signal. It requires PAYMENTS_READ.

Field	Type	Required	Default	Description
`query`	`Square.TerminalActionQuery`	No	—	Queries terminal actions based on given conditions and sort order. Leaving this unset will return all actions with the default sort order.
`cursor`	`string`	No	—	A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See Pagination for more information.
`limit`	`number`	No	—	Limit the number of results returned for a single request.

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

Output

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