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
Servers
- https://connect.squareup.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
query |
Object | No |
Represents the parameters in a search for |
query.filter |
Object | No |
Represents a filter used in a search for returns only active team members assigned to either location "A" or "B". |
query.filter.location_ids[] |
Array | No |
When present, filters by team members assigned to the specified locations. When empty, includes team members assigned to any location. |
query.filter.status |
String | No |
When present, filters by team members who match the given status. When empty, includes team members of all statuses. |
limit |
Integer | No |
The maximum number of |
cursor |
String | No |
The opaque cursor for fetching the next page. For more information, see pagination. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.