Skip to main content
GET
Get available handoff options

Authorizations

x-meetergo-api-user-id
string
header
required

User ID to act on behalf of. Platform API Keys only (required with an API Key unless the endpoint states otherwise). Requests authenticated with a Personal Access Token are rejected if this header names another user.

Query Parameters

isOnline
boolean

Filter for online users only

channelId
string

Channel ID for filtering handoffs

appointmentId
string

Appointment ID to get handoffs for

showAll
boolean

Include all company users even when the appointment belongs to a workspace

Response

200 - application/json

Successfully retrieved available handoff options

users
object[]
required

List of available users for handoff

scope
enum<string>
required

Whether the list is limited to the appointment workspace or spans the company

Available options:
workspace,
company