Skip to the content.

Team Guests API

With Team Guests api V4 you can:

Fetch a team guest

Get a team_guest. See the optional available fields.

GET /api/v4/team_guests/56?fields=inventory_item_item_id,inventory_item_battery_status,-company
{
"id": 56,
"uuid": "cf7d7471-15c5-411f-b650-7ed91e1a51f7",
"first_name": "Sammy",
"inventory_item_battery_status": 85,
"inventory_item_item_id": "4610 0839 9133",
"last_name": "Carter",
"preferred_contact": "",
"team_id": 1,
"visiting": ""
}

List team guests

Fetch a paginated list of team guests. Optional params:

GET /api/v4/teams/1/team_guests?fields=inventory_item_item_id,inventory_item_battery_status,-company&orderby=name+asc
[
  {
    "id": 55,
    "uuid": "1ddfa0f1-d8f4-4959-a3b0-e2508562657d",
    "first_name": "Douglas",
    "inventory_item_battery_status": null,
    "inventory_item_item_id": null,
    "last_name": "Hackett",
    "preferred_contact": "",
    "team_id": 1,
    "visiting": ""
  },
  {
    "id": 56,
    "uuid": "cf7d7471-15c5-411f-b650-7ed91e1a51f7",
    "first_name": "Sammy",
    "inventory_item_battery_status": 85,
    "inventory_item_item_id": "4610 0839 9133",
    "last_name": "Carter",
    "preferred_contact": "",
    "team_id": 1,
    "visiting": ""
  }
  ,
  ...
]

Available team_guest fields

You can use the fields parameter in any of the Team Guests API methods. The requested method will respond with the required fields accordingly. Some fields are included by default but you can opt-out from them on request.