# 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.

Endpoint: GET /locations/{location_id}/team_members
Version: 2.0.0
Security: BearerPartnerUser

## Security:

  - `BearerPartnerUser` (unknown)
    http bearer Bearer {PartnerToken}, User {UserToken}

## Path parameters:

  - `location_id` (integer, 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]` (integer)
    Filter by dismissal status: `0` not dismissed, `1` dismissed, `2` all

  - `filter[deleted]` (integer)
    Filter by deletion status: `0` active, `1` deleted, `2` all

  - `filter[user_linked]` (integer)
    Filter by Business User link: `0` not linked, `1` linked, `2` all

  - `filter[is_paid]` (integer)
    Filter by payment status: `0` unpaid, `1` paid, `2` all

  - `filter[has_schedule]` (integer)
    Filter by schedule: `0` without a schedule, `1` with a schedule, `2` all

  - `filter[is_assistant]` (integer)
    Filter by assistant availability: `0` unavailable, `1` available, `2` all

  - `include` (array)
    Related resources to include. Wire values are literal API keys:
- `position` - Position
- `employee` - employment profile

## Header parameters:

  - `Accept` (string, required)
    Required B2B v2 response media type. Use `application/vnd.api.v2+json`. A charset parameter is also accepted.

  - `Authorization` (string, required)
    Bearer {partner_token}, User {user_token}

## Response 200:

  - `200` (unknown)
    Team Members retrieved successfully

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.type` (string, required)
    Literal JSON:API resource type

  - `data.id` (string, required)
    Team Member ID

  - `data.attributes` (object, required)

  - `data.attributes.name` (string, required)
    Team Member name

  - `data.attributes.tt_markup` (integer, required)
    Schedule grid interval value

  - `data.attributes.specialization` (string, required)
    Team Member specialization

  - `data.attributes.image` (string, required)
    Team Member image URL

  - `data.attributes.position_id` (integer, required)
    Position ID

  - `data.attributes.is_available_as_assistant` (boolean, required)
    Whether the Team Member is available as an assistant

  - `data.relationships` (object)
    Present when related data is requested through `include`

  - `data.relationships.position` (object)

  - `data.relationships.position.data` (any, required)

  - `data.relationships.position.data.type` (string, required)

  - `data.relationships.position.data.id` (string, required)

  - `included` (array)
    Resources requested through `include`, when available

  - `included.type` (string, required)
    Literal JSON:API resource type

  - `included.id` (string, required)
    Position ID

  - `included.attributes` (object, required)

  - `included.attributes.title` (string, required)
    Position title

  - `included.id` (string, required)
    Employment profile ID

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 401 fields (application/json):

  - `success` (boolean, required)

  - `data` (null, required)

  - `meta` (object, required)

  - `meta.message` (string, required)

  - `meta.errors` (object)
    Field-level validation errors, when applicable

## Response 403:

  - `403` (unknown)
    Forbidden - No permission to read Team Members for this Location

## Response 403 fields (application/json):

  - `success` (boolean, required)

  - `data` (null, required)

  - `meta` (object, required)

  - `meta.message` (string, required)

  - `meta.errors` (object)
    Field-level validation errors, when applicable

## Response 404:

  - `404` (unknown)
    Location not found

## Response 404 fields (application/json):

  - `success` (boolean, required)

  - `data` (null, required)

  - `meta` (object, required)

  - `meta.message` (string, required)

  - `meta.errors` (object)
    Field-level validation errors, when applicable

## Response 422:

  - `422` (unknown)
    Invalid filter value

## Response 422 fields (application/json):

  - `success` (boolean, required)

  - `data` (null, required)

  - `meta` (object, required)

  - `meta.message` (string, required)

  - `meta.errors` (object)
    Field-level validation errors, when applicable