Team Members

List Team Members

Retrieve Team Members for a Location as JSON:API resource objects.

Use the filters to select Team Members by name, Position, account link, schedule, payment, dismissal, deletion, or assistant availability. Status filters use 0, 1, and 2, where 2 disables that filter.

Related data can be requested by repeating the include parameter. The employee wire value returns an employment profile that can contain sensitive employment and identity data. Request and store it only when it is necessary for the integration.

get/locations/{location_id}/team_members

Path parameters

location_idinteger required

Location ID

Query parameters

filter[name]string

Filter by a partial Team Member name match

filter[position_id]integer

Filter by Position ID

filter[position_title]string

Filter by a partial Position title match

filter[fired]0 | 1 | 2

Filter by dismissal status: 0 not dismissed, 1 dismissed, 2 all

filter[deleted]0 | 1 | 2

Filter by deletion status: 0 active, 1 deleted, 2 all

filter[user_linked]0 | 1 | 2

Filter by Business User link: 0 not linked, 1 linked, 2 all

filter[is_paid]0 | 1 | 2

Filter by payment status: 0 unpaid, 1 paid, 2 all

filter[has_schedule]0 | 1 | 2

Filter by schedule: 0 without a schedule, 1 with a schedule, 2 all

filter[is_assistant]0 | 1 | 2

Filter by assistant availability: 0 unavailable, 1 available, 2 all

includestring[]

Related resources to include. Wire values are literal API keys:

position - Position
employee - employment profile

Headers

Acceptstring required

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Authorizationstring required

Bearer {partner_token}, User {user_token}

Response

Team Members retrieved successfully