Skip to main content
GET
/
v2.0
/
handover
/
provider
/
{providerId}
Gets an Hondover Provider
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/handover/provider/{providerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "_id": "<string>",
  "referenceId": "<string>",
  "organisationId": "<string>",
  "serviceId": "<string>",
  "service": "<string>",
  "localeId": "<string>",
  "name": "<string>",
  "createdAt": 123,
  "lastChangedAt": 123,
  "createdBy": "<string>",
  "lastChangedBy": "<string>",
  "properties": [
    {}
  ],
  "settings": {}
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
providerId
string
required
Required string length: 24

Response

Returns an Handover Provider object

​
_id
string<mongoId>

The object id of the handover provider

​
referenceId
string

The referenceId of the handover provider

​
organisationId
string

The organisation Id associated with the handover provider

​
serviceId
string

The id of the service

​
service
string

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

​
localeId
string

The referenceId of the locale to use

​
name
string

The name of the handover provider resource

​
createdAt
integer

Unix-timestamp when the entity was created initially

​
lastChangedAt
integer

Unix-timestamp when the entity was last modified

​
createdBy
string<mongoId>

Id of the user who created the entity initially

​
lastChangedBy
string<mongoId>

Id of the user who made the last modification

​
properties
object[]

A list of properties associated with the handover provider

​
settings
object

Settings related to the handover provider