Get available handoff options

GET

handoff

available-handoffs

curl --request GET \
  --url https://api.example.com/v4/handoff/available-handoffs \
  --header 'x-meetergo-api-user-id: <api-key>'

{
  "users": [
    {
      "firstname": "<string>",
      "lastname": "<string>",
      "id": "<string>",
      "picture": "<string>"
    }
  ]
}

x-meetergo-api-user-id

string

header

required

User ID to act as when using API Key authentication (required with API Key)

isOnline

boolean

Filter for online users only

channelId

string

Channel ID for filtering handoffs

appointmentId

string

Appointment ID to get handoffs for

200 - application/json

Successfully retrieved available handoff options

users

object[]

required

List of available users for handoff

Show child attributes

Get available handoff options

curl --request GET \
  --url https://api.example.com/v4/handoff/available-handoffs \
  --header 'x-meetergo-api-user-id: <api-key>'

{
  "users": [
    {
      "firstname": "<string>",
      "lastname": "<string>",
      "id": "<string>",
      "picture": "<string>"
    }
  ]
}

Documentation Index