Search Team Members - Automate.ax

square.searchTeamMembers returns a paginated list of TeamMember objects for a business.

Example

automations/square-search-team-members.automation.ts

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

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

  square.searchTeamMembers({
    query: {
      filter: {
        locationIds: ["0G5P3VGACMMQZ"],
        status: "ACTIVE",
      },
    },
    limit: 10,
  })
})

Inputs

Every input accepts a compatible signal. It requires EMPLOYEES_READ.

Field	Type	Required	Default	Description
`query`	`Square.SearchTeamMembersQuery`	No	—	The query parameters.
`limit`	`number`	No	—	The maximum number of `TeamMember` objects in a page (100 by default).
`cursor`	`string`	No	—	The opaque cursor for fetching the next page. For more information, see pagination.

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

Output

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