Applies to: Team API | Labor API
Learn about managing a roster of employees, associates, or volunteers for Square sellers.
Use the Team API to create team members, update team member properties, assign wage settings, and deactivate team members. In the Square Dashboard, team members can be further configured for Square Payroll, scheduled in appointments, assigned to a labor shift, and more.
The Labor API is used with the Team API to manage timekeeping for shifts and labor cost reporting, payroll, and overtime management.
- The Sandbox Square Dashboard doesn't support all features that integrate with team members. For example, the Payroll section isn't available in the Sandbox Square Dashboard.
- The Team API cannot be used to:
- Get or set permissions for team members. Team permissions are set by the seller in the Team section of the Square Dashboard.
- Generate sales, tip, or activity reports for team members. However, you might be able to get similar data for sales and tip reporting using team member IDs with the Payments API and Labor API. For more information, see Track tips.
Your application can use the Team API to perform the following operations:
- Create and update team members to manage their profile, status, and assigned locations. Team members can be created and updated individually or in bulk.
- View and manage wage settings for a team member. A wage setting includes job assignments that define a job title, pay type, and pay rate.
- Retrieve a specific team member or list all team members.
- Search for team members by location or status.
For more information, see Integration Guide.
Team members created with the Team API are available in the Square Dashboard and integrate with the following features:
Team - The new team member is shown in the Team members list.
Sellers use the Square Dashboard to assign a passcode and permissions to team members.
Timecards - The new team member is shown in the New Shift window in the Name list.
Appointments - A team member can be added to the Staff list.
Cash drawers - A team member who is logged in with a passcode is automatically assigned to a cash drawer shift.
Payroll - A team member can be added to the payroll.
Note
Team members cannot be added to the staff for appointments, assigned to a cash drawer shift, or added to the payroll using Square APIs.
A webhook is a subscription that notifies you when a Square event occurs. For more information about using webhooks, see Square Webhooks.
The Team API uses the following webhook events:
| Event | Permission | Description |
|---|---|---|
| team_member.created | EMPLOYEES_READ | A new team member was created. |
| team_member.updated | EMPLOYEES_READ | A team member was updated. |
| team_member.wage_setting.updated | EMPLOYEES_READ | A team member wage setting was updated. |
For a complete list of webhook events, see Webhook Events Reference.