Team
SearchTeamMembers
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.
post/v2/team-members/search
Request body
Example request
{
"limit": 10,
"query": {
"filter": {
"location_ids": [
"0G5P3VGACMMQZ"
],
"status": "ACTIVE"
}
}
}Response
Success
Example response
{
"cursor": "N:9UglUjOXQ13-hMFypCft",
"team_members": [
{
"assigned_locations": {
"assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
},
"created_at": "2019-07-10T17:26:48Z",
"email_address": "johnny_cash@squareup.com",
"family_name": "Cash",
"given_name": "Johnny",
"id": "-3oZQKPKVk6gUXU_V5Qa",
"is_owner": false,
"reference_id": "12345678",
"status": "ACTIVE",
"updated_at": "2020-04-28T21:49:28Z",
"wage_setting": {
"created_at": "2021-06-11T22:55:45Z",
"is_overtime_exempt": true,
"job_assignments": [
{
"annual_rate": {
"amount": 3000000,
"currency": "USD"
},
"hourly_rate": {
"amount": 1443,
"currency": "USD"
},
"job_id": "FjS8x95cqHiMenw4f1NAUH4P",
"job_title": "Manager",
"pay_type": "SALARY",
"weekly_hours": 40
},
{
"hourly_rate": {
"amount": 2000,
"currency": "USD"
},
"job_id": "VDNpRv8da51NU8qZFC5zDWpF",
"job_title": "Cashier",
"pay_type": "HOURLY"
}
],
"team_member_id": "-3oZQKPKVk6gUXU_V5Qa",
"updated_at": "2021-06-11T22:55:45Z",
"version": 1
}
},
{
"assigned_locations": {
"assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
},
"created_at": "2020-03-24T18:14:01Z",
"family_name": "Smith",
"given_name": "Lombard",
"id": "1AVJj0DjkzbmbJw5r4KK",
"is_owner": false,
"phone_number": "+14155552671",
"reference_id": "abcded",
"status": "ACTIVE",
"updated_at": "2020-06-09T17:38:05Z",
"wage_setting": {
"created_at": "2020-03-24T18:14:01Z",
"is_overtime_exempt": true,
"job_assignments": [
{
"hourly_rate": {
"amount": 2400,
"currency": "USD"
},
"job_id": "VDNpRv8da51NU8qZFC5zDWpF",
"job_title": "Cashier",
"pay_type": "HOURLY"
}
],
"team_member_id": "1AVJj0DjkzbmbJw5r4KK",
"updated_at": "2020-06-09T17:38:05Z",
"version": 2
}
},
{
"assigned_locations": {
"assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
},
"created_at": "2020-03-24T01:09:25Z",
"family_name": "Sway",
"given_name": "Monica",
"id": "2JCmiJol_KKFs9z2Evim",
"is_owner": false,
"status": "ACTIVE",
"updated_at": "2020-03-24T01:11:25Z",
"wage_setting": {
"created_at": "2020-03-24T01:09:25Z",
"is_overtime_exempt": true,
"job_assignments": [
{
"hourly_rate": {
"amount": 2400,
"currency": "USD"
},
"job_id": "VDNpRv8da51NU8qZFC5zDWpF",
"job_title": "Cashier",
"pay_type": "HOURLY"
}
],
"team_member_id": "2JCmiJol_KKFs9z2Evim",
"updated_at": "2020-03-24T01:09:25Z",
"version": 1
}
},
{
"assigned_locations": {
"assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
},
"created_at": "2020-03-24T01:09:23Z",
"family_name": "Ipsum",
"given_name": "Elton",
"id": "4uXcJQSLtbk3F0UQHFNQ",
"is_owner": false,
"status": "ACTIVE",
"updated_at": "2020-03-24T01:15:23Z"
},
{
"assigned_locations": {
"assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
},
"created_at": "2020-03-24T01:09:23Z",
"family_name": "Lo",
"given_name": "Steven",
"id": "5CoUpyrw1YwGWcRd-eDL",
"is_owner": false,
"status": "ACTIVE",
"updated_at": "2020-03-24T01:19:23Z"
},
{
"assigned_locations": {
"assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
},
"created_at": "2020-03-24T18:14:03Z",
"family_name": "Steward",
"given_name": "Patrick",
"id": "5MRPTTp8MMBLVSmzrGha",
"is_owner": false,
"phone_number": "+14155552671",
"status": "ACTIVE",
"updated_at": "2020-03-24T18:18:03Z",
"wage_setting": {
"created_at": "2020-03-24T18:14:03Z",
"is_overtime_exempt": true,
"job_assignments": [
{
"hourly_rate": {
"amount": 2000,
"currency": "USD"
},
"job_id": "VDNpRv8da51NU8qZFC5zDWpF",
"job_title": "Cashier",
"pay_type": "HOURLY"
}
],
"team_member_id": "5MRPTTp8MMBLVSmzrGha",
"updated_at": "2020-03-24T18:14:03Z",
"version": 1
}
},
{
"assigned_locations": {
"assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
},
"created_at": "2020-03-24T01:09:25Z",
"family_name": "Manny",
"given_name": "Ivy",
"id": "7F5ZxsfRnkexhu1PTbfh",
"is_owner": false,
"status": "ACTIVE",
"updated_at": "2020-03-24T01:09:25Z"
},
{
"assigned_locations": {
"assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
},
"created_at": "2020-03-24T18:14:02Z",
"email_address": "john_smith@example.com",
"family_name": "Smith",
"given_name": "John",
"id": "808X9HR72yKvVaigQXf4",
"is_owner": false,
"phone_number": "+14155552671",
"status": "ACTIVE",
"updated_at": "2020-03-24T18:14:02Z"
},
{
"assigned_locations": {
"assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
},
"created_at": "2020-03-24T18:14:00Z",
"email_address": "r_wen@example.com",
"family_name": "Wen",
"given_name": "Robert",
"id": "9MVDVoY4hazkWKGo_OuZ",
"is_owner": false,
"phone_number": "+14155552671",
"status": "ACTIVE",
"updated_at": "2020-03-24T18:14:00Z"
},
{
"assigned_locations": {
"assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
},
"created_at": "2020-03-24T18:14:00Z",
"email_address": "asimpson@example.com",
"family_name": "Simpson",
"given_name": "Ashley",
"id": "9UglUjOXQ13-hMFypCft",
"is_owner": false,
"phone_number": "+14155552671",
"status": "ACTIVE",
"updated_at": "2020-03-24T18:18:00Z",
"wage_setting": {
"created_at": "2020-03-24T18:14:00Z",
"is_overtime_exempt": true,
"job_assignments": [
{
"hourly_rate": {
"amount": 2000,
"currency": "USD"
},
"job_id": "VDNpRv8da51NU8qZFC5zDWpF",
"job_title": "Cashier",
"pay_type": "HOURLY"
}
],
"team_member_id": "9UglUjOXQ13-hMFypCft",
"updated_at": "2020-03-24T18:14:03Z",
"version": 1
}
}
]
}