Skip to content

List Team Members

Request

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.

Security
BearerPartnerUser
Path
location_idintegerrequired

Location ID

Query
filter[name]string, non-empty

Filter by a partial Team Member name match

filter[position_id]integer, >= 0

Filter by Position ID

filter[position_title]string, non-empty

Filter by a partial Position title match

filter[fired]integer

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

Default:2
Enum:012
filter[deleted]integer

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

Default:0
Enum:012
filter[user_linked]integer

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

Default:2
Enum:012
filter[is_paid]integer

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

Default:2
Enum:012
filter[has_schedule]integer

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

Default:2
Enum:012
filter[is_assistant]integer

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

Default:2
Enum:012
includeArray of strings, unique

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

  • position - Position
  • employee - employment profile
Items Enum:"position""employee"
Headers
Acceptstringrequired

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

Default:"application/vnd.api.v2+json"
Example:application/vnd.api.v2+json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/locations/{location_id}/team_members?filter%5Bname%5D=string&filter%5Bposition_id%5D=0&filter%5Bposition_title%5D=string&filter%5Bfired%5D=0&filter%5Bdeleted%5D=0&filter%5Buser_linked%5D=0&filter%5Bis_paid%5D=0&filter%5Bhas_schedule%5D=0&filter%5Bis_assistant%5D=0&include=position' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Team Members retrieved successfully

Bodyapplication/json
dataArray of objects(Team Member Resource)required
includedArray of any

Resources requested through include, when available

Response
{
  "data": [
    { … }
  ]
}