Square API
You are viewing an old version of the API
Team
Square API
Pull employee data into accounting and payroll systems with the Team API.
The Team API allows applications to retrieve a roster of team members registered in the Square Point of Sale system, which can be useful in payroll and account contexts.
The Team API is best used in conjunction with the Labor API, where you provide team member IDs to manage shifts, breaks, and wages.
Guides: Team
-
Create team member
POST /v2/team-members - Creates a single TeamMember object.
-
Bulk create team members
POST /v2/team-members/bulk-create - Creates multiple TeamMember objects.
-
Bulk update team members
POST /v2/team-members/bulk-update - Updates multiple TeamMember objects.
-
Search team members
POST /v2/team-members/search - Returns a paginated list of TeamMember objects for a business.
-
Retrieve team member
GET /v2/team-members/{team_member_id} - Retrieves a TeamMember object for the given TeamMember.id.
-
Update team member
PUT /v2/team-members/{team_member_id} - Updates a single TeamMember object.
-
Retrieve wage setting
GET /v2/team-members/{team_member_id}/wage-setting - Retrieves a WageSetting object for a team member specified by TeamMember.id.
-
Update wage setting
PUT /v2/team-members/{team_member_id}/wage-setting - Creates or updates a WageSetting object.