Lists available team members, including contact details, status, and location assignments.

Table Specific Information

Select

The driver uses the Square API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the driver.

• Id supports the following operator: =.
• Status supports the following operator: =.
• IsOwner supports the following operator: =.
• LocationId supports the following operators: =, IN.

Retrieve a specific team member:

SELECT * FROM Teams WHERE Id = '1ccaibDk3FapStf997Qi'

Retrieve the team member for a specific location:

SELECT * FROM Teams WHERE LocationId = '92BYHNBR6W77E'

Note: Team members may belong to multiple LocationIds, which can result in multiple values appearing in the LocationId column. Additionally, team members whose 'AssignmentType' is set to 'ALL_CURRENT_AND_FUTURE_LOCATIONS' will have a NULL value in the LocationId field, even though they have access to data across all LocationIds. This is expected behavior of the Square API.

Retrieve list of team members for specified locations:

SELECT * FROM Teams WHERE LocationId IN ('92BYHNBR6W77E', '92BYHNBR6W77EABCD', '92BYHNBR6W77EABCDEFGH')

Retrieve list of active team members:

SELECT * FROM Teams WHERE Status = 'ACTIVE'

Retrieve list of active team members in a given location:

SELECT * FROM Teams WHERE LocationId = '92BYHNBR6W77E' AND Status = 'ACTIVE'

Insert

To create a team, you must specify IdempotencyKey and FirstName or LastName.

INSERT INTO Teams (IdempotencyKey, FirstName) VALUES ('b741f5a5-c041-4bd6-9e79-dfefcf69c4b7','testing')

Update

A team can be updated by providing its Id.

UPDATE Teams SET FirstName='testteams' WHERE Id='TMiAkBLr8BOrtOCr'

Bulk Update

The maximum BatchSize supported by Teams is 25.

A team can be bulk updated by providing its Id.

INSERT INTO Teams#TEMP (FirstName, LastName, Id) VALUES ('UpdatedFirstName1', 'UpdatedLastName1', 'TMD64VkEfI47Vm3G')

INSERT INTO Teams#TEMP (FirstName, LastName, Id) VALUES ('UpdatedFirstName2', 'UpdatedLastName2', 'TMHxLjeRSHhwzx3T')

UPDATE Teams (FirstName, LastName, Id) SELECT FirstName, LastName, Id FROM Teams#TEMP

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the team member.
FirstName	String	False	The first name of the team member.
LastName	String	False	The last name of the team member.
Email	String	False	The email address of the team member.
Status	String	False	Indicates whether the team member is active or inactive. The allowed values are ACTIVE, INACTIVE.
CreatedAt	Datetime	True	The time when the team member entity was created.
UpdatedAt	Datetime	True	The time when the team member entity was last updated.
PhoneNumber	String	False	The phone number of the team member.
ReferenceId	String	False	A second Id used to associate the team member with an entity in another system.
IsOwner	Boolean	True	Indicates whether the team member is the owner of the Square account.
AssignmentType	String	False	The current assignment type of the team member. The allowed values are ALL_CURRENT_AND_FUTURE_LOCATIONS, EXPLICIT_LOCATIONS.
LocationId	String	False	The locations that the team member is assigned to.
WageSetting	String	False	Information about the team member overtime exemption status, job assignments, and compensation. (Beta)

Pseudocolumns

Pseudo column fields are used in the WHERE clause of SELECT statements (unless stated otherwise) and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
IdempotencyKey	String	A unique string that identifies the request. Supported only for INSERT operations. Maximum length is 45 characters.