The Team Members API provides methods to create, retrieve, update, and search for team members in your Square account.
Overview
The client.TeamMembers client provides access to team member management operations:
import (
"context"
"github.com/square/square-go-sdk/v3"
)
client := square.NewClient(
square.WithAccessToken("YOUR_ACCESS_TOKEN"),
)
// Use the TeamMembers client
response, err := client.TeamMembers.Search(context.Background(), &square.SearchTeamMembersRequest{})
Methods
Create
Creates a single TeamMember object. The created TeamMember object is returned on successful creates.
request := &square.CreateTeamMemberRequest{
TeamMember: &square.TeamMember{
GivenName: square.String("Joe"),
FamilyName: square.String("Doe"),
EmailAddress: square.String("[email protected]"),
PhoneNumber: square.String("+14155552671"),
AssignedLocations: &square.TeamMemberAssignedLocations{
AssignmentType: square.TeamMemberAssignedLocationsAssignmentTypeExplicitLocations.Ptr(),
LocationIDs: []string{"LOCATION_ID_1", "LOCATION_ID_2"},
},
},
}
response, err := client.TeamMembers.Create(context.Background(), request)
if err != nil {
log.Fatal(err)
}
fmt.Printf("Created team member: %s\n", *response.TeamMember.ID)
A unique string that identifies this CreateTeamMember request. Keys can be any valid string, but must be unique for every request. The minimum length is 1 and the maximum length is 45.
teamMember
*square.TeamMember
required
The data used to create the TeamMember object. If you include wage_setting, you must provide job_id for each job assignment. To get job IDs, use the Team API.
BatchCreate
Creates multiple TeamMember objects. The created TeamMember objects are returned on successful creates. This process is non-transactional and processes as much of the request as possible.
request := &square.BatchCreateTeamMembersRequest{
TeamMembers: map[string]*square.CreateTeamMemberRequest{
"idempotency-key-1": &square.CreateTeamMemberRequest{
TeamMember: &square.TeamMember{
ReferenceID: square.String("reference_id_1"),
GivenName: square.String("Joe"),
FamilyName: square.String("Doe"),
EmailAddress: square.String("[email protected]"),
PhoneNumber: square.String("+14159283333"),
AssignedLocations: &square.TeamMemberAssignedLocations{
AssignmentType: square.TeamMemberAssignedLocationsAssignmentTypeExplicitLocations.Ptr(),
LocationIDs: []string{"YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"},
},
},
},
},
}
response, err := client.TeamMembers.BatchCreate(context.Background(), request)
if err != nil {
log.Fatal(err)
}
teamMembers
map[string]*square.CreateTeamMemberRequest
required
The data used to create the TeamMember objects. Each key is the idempotency_key that maps to the CreateTeamMemberRequest. The maximum number of create objects is 25.
BatchUpdate
Updates multiple TeamMember objects. The updated TeamMember objects are returned on successful updates.
request := &square.BatchUpdateTeamMembersRequest{
TeamMembers: map[string]*square.UpdateTeamMemberRequest{
"team-member-id-1": &square.UpdateTeamMemberRequest{
TeamMember: &square.TeamMember{
GivenName: square.String("Jane"),
FamilyName: square.String("Smith"),
EmailAddress: square.String("[email protected]"),
PhoneNumber: square.String("+14159223334"),
},
},
},
}
response, err := client.TeamMembers.BatchUpdate(context.Background(), request)
if err != nil {
log.Fatal(err)
}
teamMembers
map[string]*square.UpdateTeamMemberRequest
required
The data used to update the TeamMember objects. Each key is the team_member_id that maps to the UpdateTeamMemberRequest. The maximum number of update objects is 25.
Search
Returns a paginated list of TeamMember objects for a business. The list can be filtered by location IDs, ACTIVE or INACTIVE status, or whether the team member is the Square account owner.
request := &square.SearchTeamMembersRequest{
Query: &square.SearchTeamMembersQuery{
Filter: &square.SearchTeamMembersFilter{
LocationIDs: []string{"0G5P3VGACMMQZ"},
Status: square.TeamMemberStatusActive.Ptr(),
},
},
Limit: square.Int(10),
}
response, err := client.TeamMembers.Search(context.Background(), request)
if err != nil {
log.Fatal(err)
}
for _, member := range response.TeamMembers {
fmt.Printf("%s %s\n", *member.GivenName, *member.FamilyName)
}
query
*square.SearchTeamMembersQuery
The query parameters.
The maximum number of TeamMember objects in a page (100 by default).
The opaque cursor for fetching the next page. For more information, see pagination. Get
Retrieves a TeamMember object for the given TeamMember.id.
request := &square.GetTeamMembersRequest{
TeamMemberID: "team_member_id",
}
response, err := client.TeamMembers.Get(context.Background(), request)
if err != nil {
log.Fatal(err)
}
fmt.Printf("Team member: %s %s\n", *response.TeamMember.GivenName, *response.TeamMember.FamilyName)
The ID of the team member to retrieve.
Update
Updates a single TeamMember object. The TeamMember object is returned on successful updates.
request := &square.UpdateTeamMembersRequest{
TeamMemberID: "team_member_id",
Body: &square.UpdateTeamMemberRequest{
TeamMember: &square.TeamMember{
GivenName: square.String("Joe"),
FamilyName: square.String("Doe"),
EmailAddress: square.String("[email protected]"),
PhoneNumber: square.String("+14159283333"),
},
},
}
response, err := client.TeamMembers.Update(context.Background(), request)
if err != nil {
log.Fatal(err)
}
The ID of the team member to update.
teamMember
*square.TeamMember
required
The team member fields to add, change, or clear. Fields can be cleared using a null value. To update wage_setting.job_assignments, you must provide the complete list of job assignments.
TeamMember Object
The unique ID for the team member.
A second ID used to associate the team member with an entity in another system.
Whether the team member is the owner of the Square account.
Describes the status of the team member. Possible values: ACTIVE, INACTIVE.
The given name (first name) associated with the team member.
The family name (last name) associated with the team member.
The email address associated with the team member.
The team member’s phone number, in E.164 format (e.g., +14155552671).
The timestamp when the team member was created, in RFC 3339 format.
The timestamp when the team member was last updated, in RFC 3339 format.
assignedLocations
*square.TeamMemberAssignedLocations
Describes the team member’s assigned locations.
Information about the team member’s overtime exemption status, job assignments, and compensation.
