team_api = client.team
TeamApi
- Create Team Member
- Bulk Create Team Members
- Bulk Update Team Members
- Search Team Members
- Retrieve Team Member
- Update Team Member
- Retrieve Wage Setting
- Update Wage Setting
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)
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. |
body = {}
body['idempotency_key'] = 'idempotency-key-0'
body['team_member'] = {}
body['team_member']['id'] = 'id2'
body['team_member']['reference_id'] = 'reference_id_1'
body['team_member']['is_owner'] = False
body['team_member']['status'] = 'ACTIVE'
body['team_member']['given_name'] = 'Joe'
body['team_member']['family_name'] = 'Doe'
body['team_member']['email_address'] = '[email protected]'
body['team_member']['phone_number'] = '+14159283333'
body['team_member']['assigned_locations'] = {}
body['team_member']['assigned_locations']['assignment_type'] = 'EXPLICIT_LOCATIONS'
body['team_member']['assigned_locations']['location_ids'] = ['YSGH2WBKG94QZ', 'GA2Y9HSJ8KRYT']
result = team_api.create_team_member(body)
if result.is_success():
print(result.body)
elif result.is_error():
print(result.errors)
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)
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. |
Bulk Create Team Members Response
body = {}
body['team_members'] = {}
result = team_api.bulk_create_team_members(body)
if result.is_success():
print(result.body)
elif result.is_error():
print(result.errors)
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)
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. |
Bulk Update Team Members Response
body = {}
body['team_members'] = {}
result = team_api.bulk_update_team_members(body)
if result.is_success():
print(result.body)
elif result.is_error():
print(result.errors)
Returns a paginated list of TeamMember
objects for a business.
The list can be filtered by the following:
- location IDs
status
def search_team_members(self,
body)
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. |
body = {}
body['query'] = {}
body['query']['filter'] = {}
body['query']['filter']['location_ids'] = ['0G5P3VGACMMQZ']
body['query']['filter']['status'] = 'ACTIVE'
body['limit'] = 10
body['cursor'] = 'cursor0'
result = team_api.search_team_members(body)
if result.is_success():
print(result.body)
elif result.is_error():
print(result.errors)
Retrieves a TeamMember
object for the given TeamMember.id
.
Learn about Troubleshooting the Team API.
def retrieve_team_member(self,
team_member_id)
Parameter | Type | Tags | Description |
---|---|---|---|
team_member_id |
string |
Template, Required | The ID of the team member to retrieve. |
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)
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)
Parameter | Type | Tags | Description |
---|---|---|---|
team_member_id |
string |
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. |
team_member_id = 'team_member_id0'
body = {}
body['team_member'] = {}
body['team_member']['id'] = 'id2'
body['team_member']['reference_id'] = 'reference_id_1'
body['team_member']['is_owner'] = False
body['team_member']['status'] = 'ACTIVE'
body['team_member']['given_name'] = 'Joe'
body['team_member']['family_name'] = 'Doe'
body['team_member']['email_address'] = '[email protected]'
body['team_member']['phone_number'] = '+14159283333'
body['team_member']['assigned_locations'] = {}
body['team_member']['assigned_locations']['assignment_type'] = 'EXPLICIT_LOCATIONS'
body['team_member']['assigned_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)
Retrieves a WageSetting
object for a team member specified
by TeamMember.id
.
Learn about Troubleshooting the Team API.
def retrieve_wage_setting(self,
team_member_id)
Parameter | Type | Tags | Description |
---|---|---|---|
team_member_id |
string |
Template, Required | The ID of the team member for which to retrieve the wage setting. |
Retrieve Wage Setting Response
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)
Creates or updates a WageSetting
object. The object is created if a
WageSetting
with the specified team_member_id
does not exist. Otherwise,
it fully replaces the WageSetting
object for the team member.
The WageSetting
is returned on a successful update.
Learn about Troubleshooting the Team API.
def update_wage_setting(self,
team_member_id,
body)
Parameter | Type | Tags | Description |
---|---|---|---|
team_member_id |
string |
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. |
team_member_id = 'team_member_id0'
body = {}
body['wage_setting'] = {}
body['wage_setting']['team_member_id'] = 'team_member_id2'
body['wage_setting']['job_assignments'] = []
body['wage_setting']['job_assignments'].append({})
body['wage_setting']['job_assignments'][0]['job_title'] = 'Manager'
body['wage_setting']['job_assignments'][0]['pay_type'] = 'SALARY'
body['wage_setting']['job_assignments'][0]['hourly_rate'] = {}
body['wage_setting']['job_assignments'][0]['hourly_rate']['amount'] = 117
body['wage_setting']['job_assignments'][0]['hourly_rate']['currency'] = 'ERN'
body['wage_setting']['job_assignments'][0]['annual_rate'] = {}
body['wage_setting']['job_assignments'][0]['annual_rate']['amount'] = 3000000
body['wage_setting']['job_assignments'][0]['annual_rate']['currency'] = 'USD'
body['wage_setting']['job_assignments'][0]['weekly_hours'] = 40
body['wage_setting']['job_assignments'].append({})
body['wage_setting']['job_assignments'][1]['job_title'] = 'Cashier'
body['wage_setting']['job_assignments'][1]['pay_type'] = 'HOURLY'
body['wage_setting']['job_assignments'][1]['hourly_rate'] = {}
body['wage_setting']['job_assignments'][1]['hourly_rate']['amount'] = 1200
body['wage_setting']['job_assignments'][1]['hourly_rate']['currency'] = 'USD'
body['wage_setting']['job_assignments'][1]['annual_rate'] = {}
body['wage_setting']['job_assignments'][1]['annual_rate']['amount'] = 58
body['wage_setting']['job_assignments'][1]['annual_rate']['currency'] = 'DZD'
body['wage_setting']['job_assignments'][1]['weekly_hours'] = 226
body['wage_setting']['is_overtime_exempt'] = True
body['wage_setting']['version'] = 122
body['wage_setting']['created_at'] = 'created_at0'
result = team_api.update_wage_setting(team_member_id, body)
if result.is_success():
print(result.body)
elif result.is_error():
print(result.errors)