List Gift Cards - Automate.ax

square.listGiftCards lists all gift cards.

Example

automations/square-list-gift-cards.automation.ts

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

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

  square.listGiftCards({
    type: "type",
    state: "state",
    limit: 1,
    cursor: "cursor",
    customerId: "customer_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires GIFTCARDS_READ.

Field	Type	Required	Default	Description
`type`	`string \| null`	No	—	If a type is provided, the endpoint returns gift cards of the specified type. Otherwise, the endpoint returns gift cards of all types.
`state`	`string \| null`	No	—	If a state is provided, the endpoint returns the gift cards in the specified state. Otherwise, the endpoint returns the gift cards of all states.
`limit`	`number \| null`	No	30	If a limit is provided, the endpoint returns only the specified number of results per page. The maximum value is 200. The default value is 30. For more information, see Pagination.
`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. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see Pagination.
`customerId`	`string \| null`	No	—	If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer.

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

Output

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