Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Handover Providers

Get a Handover Provider

Gets a handover provider from a Project.

get/v2.0/handover/providers/{providerId}

Path parameters

providerIdstring required

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Response

Returns a Handover Provider object.

_idstring mongoId

The object id of the handover provider

referenceIdstring

The referenceId of the handover provider

organisationIdstring

The organisation Id associated with the handover provider

serviceIdstring

The id of the service

servicestring

The handover provider's specified service; e.g., Live Agent, Genesys

localeIdstring

The referenceId of the locale to use

namestring

The name of the handover provider resource

createdAtinteger

Unix-timestamp when the entity was created initially

lastChangedAtinteger

Unix-timestamp when the entity was last modified

createdBystring mongoId

Id of the user who created the entity initially

lastChangedBystring mongoId

Id of the user who made the last modification

propertiesobject[]

A list of properties associated with the handover provider

settingsobject

Settings related to the handover provider