Object Index

You are viewing an old version of the API

All Versions

SearchTeamMembersFilter

Represents a filter used in a search for TeamMember objects.

AND logic is applied between the individual fields, and OR logic is applied within list-based fields. For example, setting this filter value:

  filter = (locations_ids = ["A", "B"], status = ACTIVE)

returns only active team members assigned to either location "A" or "B".

Properties

Name	Description
`location_ids string [ ]`	When present, filters by team members assigned to the specified locations. When empty, includes team members assigned to any location.
`status string`	When present, filters by team members who match the given status. When empty, includes team members of all statuses.
`is_owner boolean`	When present and set to true, returns the team member who is the owner of the Square account.