Search team members

POST

/v2/team-members/search

Returns a paginated list of TeamMember objects for a business.

The list can be filtered by the following:

location IDs
status

Permissions:EMPLOYEES_READ

Guide

Search for team members

Try in API Explorer

Link to section

Request body

Example code

Link to section

query

The query parameters.

Link to section

limit

integer(32-bit)

The maximum number of TeamMember objects in a page (100 by default).

Min

Max

200

Link to section

cursor

string

The opaque cursor for fetching the next page. For more information, see pagination.

Link to section

Response fields

Link to section

team_members

The filtered list of TeamMember objects.

Link to section

cursor

string

The opaque cursor for fetching the next page. For more information, see pagination.

Link to section

errors

The errors that occurred during the request.

Link to section

Examples

POST /v2/team-members/search

curl https://connect.squareup.com/v2/team-members/search \
  -X POST \
  -H 'Square-Version: 2023-08-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": {
      "filter": {
        "location_ids": [
          "0G5P3VGACMMQZ"
        ],
        "status": "ACTIVE"
      }
    },
    "limit": 10
  }'

Response JSON

{
  "team_members": [
    {
      "id": "-3oZQKPKVk6gUXU_V5Qa",
      "reference_id": "12345678",
      "is_owner": false,
      "status": "ACTIVE",
      "given_name": "Johnny",
      "family_name": "Cash",
      "email_address": "[email protected]",
      "created_at": "2019-07-10T17:26:48Z",
      "updated_at": "2020-04-28T21:49:28Z",
      "assigned_locations": {
        "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
      }
    },
    {
      "id": "1AVJj0DjkzbmbJw5r4KK",
      "reference_id": "abcded",
      "is_owner": false,
      "status": "ACTIVE",
      "given_name": "Lombard",
      "family_name": "Smith",
      "phone_number": "+14155552671",
      "created_at": "2020-03-24T18:14:01Z",
      "updated_at": "2020-06-09T17:38:05Z",
      "assigned_locations": {
        "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
      }
    },
    {
      "id": "2JCmiJol_KKFs9z2Evim",
      "is_owner": false,
      "status": "ACTIVE",
      "given_name": "Monica",
      "family_name": "Sway",
      "created_at": "2020-03-24T01:09:25Z",
      "updated_at": "2020-03-24T01:11:25Z",
      "assigned_locations": {
        "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
      }
    },
    {
      "id": "4uXcJQSLtbk3F0UQHFNQ",
      "is_owner": false,
      "status": "ACTIVE",
      "given_name": "Elton",
      "family_name": "Ipsum",
      "created_at": "2020-03-24T01:09:23Z",
      "updated_at": "2020-03-24T01:15:23Z",
      "assigned_locations": {
        "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
      }
    },
    {
      "id": "5CoUpyrw1YwGWcRd-eDL",
      "is_owner": false,
      "status": "ACTIVE",
      "given_name": "Steven",
      "family_name": "Lo",
      "created_at": "2020-03-24T01:09:23Z",
      "updated_at": "2020-03-24T01:19:23Z",
      "assigned_locations": {
        "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
      }
    },
    {
      "id": "5MRPTTp8MMBLVSmzrGha",
      "is_owner": false,
      "status": "ACTIVE",
      "given_name": "Patrick",
      "family_name": "Steward",
      "phone_number": "+14155552671",
      "created_at": "2020-03-24T18:14:03Z",
      "updated_at": "2020-03-24T18:18:03Z",
      "assigned_locations": {
        "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
      }
    },
    {
      "id": "7F5ZxsfRnkexhu1PTbfh",
      "is_owner": false,
      "status": "ACTIVE",
      "given_name": "Ivy",
      "family_name": "Manny",
      "created_at": "2020-03-24T01:09:25Z",
      "updated_at": "2020-03-24T01:09:25Z",
      "assigned_locations": {
        "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
      }
    },
    {
      "id": "808X9HR72yKvVaigQXf4",
      "is_owner": false,
      "status": "ACTIVE",
      "given_name": "John",
      "family_name": "Smith",
      "email_address": "[email protected]",
      "phone_number": "+14155552671",
      "created_at": "2020-03-24T18:14:02Z",
      "updated_at": "2020-03-24T18:14:02Z",
      "assigned_locations": {
        "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
      }
    },
    {
      "id": "9MVDVoY4hazkWKGo_OuZ",
      "is_owner": false,
      "status": "ACTIVE",
      "given_name": "Robert",
      "family_name": "Wen",
      "email_address": "[email protected]",
      "phone_number": "+14155552671",
      "created_at": "2020-03-24T18:14:00Z",
      "updated_at": "2020-03-24T18:14:00Z",
      "assigned_locations": {
        "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
      }
    },
    {
      "id": "9UglUjOXQ13-hMFypCft",
      "is_owner": false,
      "status": "ACTIVE",
      "given_name": "Ashley",
      "family_name": "Simpson",
      "email_address": "[email protected]",
      "phone_number": "+14155552671",
      "created_at": "2020-03-24T18:14:00Z",
      "updated_at": "2020-03-24T18:18:00Z",
      "assigned_locations": {
        "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
      }
    }
  ],
  "cursor": "N:9UglUjOXQ13-hMFypCft"
}