• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
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, filter by team members assigned to the specified locations. When empty, include team members assigned to any location.

status
string

When present, filter by team members who match the given status. When empty, include team members of all statuses.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?