Team

team_api = client.team

Class Name

TeamApi

Methods

Create Team Member
Bulk Create Team Members
Bulk Update Team Members
List Jobs
Create Job
Retrieve Job
Update Job
Search Team Members
Retrieve Team Member
Update Team Member
Retrieve Wage Setting
Update Wage Setting

Create Team Member

Creates a single TeamMember object. The TeamMember object is returned on successful creates. You must provide the following values in your request to this endpoint:

given_name
family_name

Learn about Troubleshooting the Team API.

def create_team_member(self,
                      body)

Parameters

Parameter	Type	Tags	Description
`body`	`Create Team Member Request`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Create Team Member Response.

Example Usage

body = {
    'idempotency_key': 'idempotency-key-0',
    'team_member': {
        'reference_id': 'reference_id_1',
        'status': 'ACTIVE',
        'given_name': 'Joe',
        'family_name': 'Doe',
        'email_address': 'joe_doe@gmail.com',
        'phone_number': '+14159283333',
        'assigned_locations': {
            'assignment_type': 'EXPLICIT_LOCATIONS',
            'location_ids': [
                'YSGH2WBKG94QZ',
                'GA2Y9HSJ8KRYT'
            ]
        },
        'wage_setting': {
            'job_assignments': [
                {
                    'pay_type': 'SALARY',
                    'annual_rate': {
                        'amount': 3000000,
                        'currency': 'USD'
                    },
                    'weekly_hours': 40,
                    'job_id': 'FjS8x95cqHiMenw4f1NAUH4P'
                },
                {
                    'pay_type': 'HOURLY',
                    'hourly_rate': {
                        'amount': 2000,
                        'currency': 'USD'
                    },
                    'job_id': 'VDNpRv8da51NU8qZFC5zDWpF'
                }
            ],
            'is_overtime_exempt': True
        }
    }
}

result = team_api.create_team_member(body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Bulk Create Team Members

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. If one of the creates in the request cannot be successfully processed, the request is not marked as failed, but the body of the response contains explicit error information for the failed create.

Learn about Troubleshooting the Team API.

def bulk_create_team_members(self,
                            body)

Parameters

Parameter	Type	Tags	Description
`body`	`Bulk Create Team Members Request`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Bulk Create Team Members Response.

Example Usage

body = {
    'team_members': {
        'idempotency-key-1': {
            'team_member': {
                'reference_id': 'reference_id_1',
                'given_name': 'Joe',
                'family_name': 'Doe',
                'email_address': 'joe_doe@gmail.com',
                'phone_number': '+14159283333',
                'assigned_locations': {
                    'assignment_type': 'EXPLICIT_LOCATIONS',
                    'location_ids': [
                        'YSGH2WBKG94QZ',
                        'GA2Y9HSJ8KRYT'
                    ]
                }
            }
        },
        'idempotency-key-2': {
            'team_member': {
                'reference_id': 'reference_id_2',
                'given_name': 'Jane',
                'family_name': 'Smith',
                'email_address': 'jane_smith@gmail.com',
                'phone_number': '+14159223334',
                'assigned_locations': {
                    'assignment_type': 'ALL_CURRENT_AND_FUTURE_LOCATIONS'
                }
            }
        }
    }
}

result = team_api.bulk_create_team_members(body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Bulk Update Team Members

Updates multiple TeamMember objects. The updated TeamMember objects are returned on successful updates. This process is non-transactional and processes as much of the request as possible. If one of the updates in the request cannot be successfully processed, the request is not marked as failed, but the body of the response contains explicit error information for the failed update. Learn about Troubleshooting the Team API.

def bulk_update_team_members(self,
                            body)

Parameters

Parameter	Type	Tags	Description
`body`	`Bulk Update Team Members Request`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Bulk Update Team Members Response.

Example Usage

body = {
    'team_members': {
        'AFMwA08kR-MIF-3Vs0OE': {
            'team_member': {
                'reference_id': 'reference_id_2',
                'status': 'ACTIVE',
                'given_name': 'Jane',
                'family_name': 'Smith',
                'email_address': 'jane_smith@gmail.com',
                'phone_number': '+14159223334',
                'assigned_locations': {
                    'assignment_type': 'ALL_CURRENT_AND_FUTURE_LOCATIONS'
                }
            }
        },
        'fpgteZNMaf0qOK-a4t6P': {
            'team_member': {
                'reference_id': 'reference_id_1',
                'status': 'ACTIVE',
                'given_name': 'Joe',
                'family_name': 'Doe',
                'email_address': 'joe_doe@gmail.com',
                'phone_number': '+14159283333',
                'assigned_locations': {
                    'assignment_type': 'EXPLICIT_LOCATIONS',
                    'location_ids': [
                        'YSGH2WBKG94QZ',
                        'GA2Y9HSJ8KRYT'
                    ]
                }
            }
        }
    }
}

result = team_api.bulk_update_team_members(body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

List Jobs

Lists jobs in a seller account. Results are sorted by title in ascending order.

def list_jobs(self,
             cursor=None)

Parameters

Parameter	Type	Tags	Description
`cursor`	`str`	Query, Optional	The pagination cursor returned by the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see Pagination.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type List Jobs Response.

Example Usage

result = team_api.list_jobs()

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Create Job

Creates a job in a seller account. A job defines a title and tip eligibility. Note that compensation is defined in a job assignment in a team member's wage setting.

def create_job(self,
              body)

Parameters

Parameter	Type	Tags	Description
`body`	`Create Job Request`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Create Job Response.

Example Usage

body = {
    'job': {
        'title': 'Cashier',
        'is_tip_eligible': True
    },
    'idempotency_key': 'idempotency-key-0'
}

result = team_api.create_job(body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Retrieve Job

Retrieves a specified job.

def retrieve_job(self,
                job_id)

Parameters

Parameter	Type	Tags	Description
`job_id`	`str`	Template, Required	The ID of the job to retrieve.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Retrieve Job Response.

Example Usage

job_id = 'job_id2'

result = team_api.retrieve_job(job_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Update Job

Updates the title or tip eligibility of a job. Changes to the title propagate to all JobAssignment, Shift, and TeamMemberWage objects that reference the job ID. Changes to tip eligibility propagate to all TeamMemberWage objects that reference the job ID.

def update_job(self,
              job_id,
              body)

Parameters

Parameter	Type	Tags	Description
`job_id`	`str`	Template, Required	The ID of the job to update.
`body`	`Update Job Request`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Update Job Response.

Example Usage

job_id = 'job_id2'

body = {
    'job': {
        'title': 'Cashier 1',
        'is_tip_eligible': True
    }
}

result = team_api.update_job(
    job_id,
    body
)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Search Team Members

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.

def search_team_members(self,
                       body)

Parameters

Parameter	Type	Tags	Description
`body`	`Search Team Members Request`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Search Team Members Response.

Example Usage

body = {
    'query': {
        'filter': {
            'location_ids': [
                '0G5P3VGACMMQZ'
            ],
            'status': 'ACTIVE'
        }
    },
    'limit': 10
}

result = team_api.search_team_members(body)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Retrieve Team Member

Retrieves a TeamMember object for the given TeamMember.id. Learn about Troubleshooting the Team API.

def retrieve_team_member(self,
                        team_member_id)

Parameters

Parameter	Type	Tags	Description
`team_member_id`	`str`	Template, Required	The ID of the team member to retrieve.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Retrieve Team Member Response.

Example Usage

team_member_id = 'team_member_id0'

result = team_api.retrieve_team_member(team_member_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Update Team Member

Updates a single TeamMember object. The TeamMember object is returned on successful updates. Learn about Troubleshooting the Team API.

def update_team_member(self,
                      team_member_id,
                      body)

Parameters

Parameter	Type	Tags	Description
`team_member_id`	`str`	Template, Required	The ID of the team member to update.
`body`	`Update Team Member Request`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Update Team Member Response.

Example Usage

team_member_id = 'team_member_id0'

body = {
    'team_member': {
        'reference_id': 'reference_id_1',
        'status': 'ACTIVE',
        'given_name': 'Joe',
        'family_name': 'Doe',
        'email_address': 'joe_doe@gmail.com',
        'phone_number': '+14159283333',
        'assigned_locations': {
            'assignment_type': 'EXPLICIT_LOCATIONS',
            'location_ids': [
                'YSGH2WBKG94QZ',
                'GA2Y9HSJ8KRYT'
            ]
        }
    }
}

result = team_api.update_team_member(
    team_member_id,
    body
)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Retrieve Wage Setting

Retrieves a WageSetting object for a team member specified by TeamMember.id. For more information, see Troubleshooting the Team API.

Square recommends using RetrieveTeamMember or SearchTeamMembers to get this information directly from the TeamMember.wage_setting field.

def retrieve_wage_setting(self,
                         team_member_id)

Parameters

Parameter	Type	Tags	Description
`team_member_id`	`str`	Template, Required	The ID of the team member for which to retrieve the wage setting.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Retrieve Wage Setting Response.

Example Usage

team_member_id = 'team_member_id0'

result = team_api.retrieve_wage_setting(team_member_id)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Update Wage Setting

Creates or updates a WageSetting object. The object is created if a WageSetting with the specified team_member_id doesn't exist. Otherwise, it fully replaces the WageSetting object for the team member. The WageSetting is returned on a successful update. For more information, see Troubleshooting the Team API.

Square recommends using CreateTeamMember or UpdateTeamMember to manage the TeamMember.wage_setting field directly.

def update_wage_setting(self,
                       team_member_id,
                       body)

Parameters

Parameter	Type	Tags	Description
`team_member_id`	`str`	Template, Required	The ID of the team member for which to update the `WageSetting` object.
`body`	`Update Wage Setting Request`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The body property of this instance returns the response data which is of type Update Wage Setting Response.

Example Usage

team_member_id = 'team_member_id0'

body = {
    'wage_setting': {
        'job_assignments': [
            {
                'pay_type': 'SALARY',
                'job_title': 'Manager',
                'annual_rate': {
                    'amount': 3000000,
                    'currency': 'USD'
                },
                'weekly_hours': 40
            },
            {
                'pay_type': 'HOURLY',
                'job_title': 'Cashier',
                'hourly_rate': {
                    'amount': 2000,
                    'currency': 'USD'
                }
            }
        ],
        'is_overtime_exempt': True
    }
}

result = team_api.update_wage_setting(
    team_member_id,
    body
)

if result.is_success():
    print(result.body)
elif result.is_error():
    print(result.errors)

Files

team.md

Latest commit

History

team.md

File metadata and controls

Team

Class Name

Methods

Create Team Member

Parameters

Response Type

Example Usage

Bulk Create Team Members

Parameters

Response Type

Example Usage

Bulk Update Team Members

Parameters

Response Type

Example Usage

List Jobs

Parameters

Response Type

Example Usage

Create Job

Parameters

Response Type

Example Usage

Retrieve Job

Parameters

Response Type

Example Usage

Update Job

Parameters

Response Type

Example Usage

Search Team Members

Parameters

Response Type

Example Usage

Retrieve Team Member

Parameters

Response Type

Example Usage

Update Team Member

Parameters

Response Type

Example Usage

Retrieve Wage Setting

Parameters

Response Type

Example Usage

Update Wage Setting

Parameters

Response Type

Example Usage