Handoff V4

Get available handoff options

Retrieves available users or queues that can receive a handoff for the specified criteria.

get/v4/handoff/available-handoffs

Request

  • Base URL: https://developer.meetergo.com (the document declares no server; this is the origin it was published from)
  • URL: https://developer.meetergo.com/v4/handoff/available-handoffs
  • Auth: one of:
    • API key in header x-meetergo-api-user-id
    • HTTP bearer
    • HTTP bearer

Query parameters

isOnlineboolean

Filter for online users only

channelIdstring

Channel ID for filtering handoffs

appointmentIdstring

Appointment ID to get handoffs for

showAllboolean

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

Response

Successfully retrieved available handoff options

scope'workspace' | 'company' required

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

Changes

No recorded changes to this operation across all 1 revision of this API.