Skip to main content
GET
/
v2.0
/
handover
/
providers
Get Handover Providers
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/handover/providers \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "_id": "<string>",
      "referenceId": "<string>",
      "organisationId": "<string>",
      "serviceId": "<string>",
      "service": "<string>",
      "localeId": "<string>",
      "name": "<string>",
      "createdAt": 123,
      "lastChangedAt": 123,
      "createdBy": "<string>",
      "lastChangedBy": "<string>",
      "properties": [
        {}
      ],
      "settings": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

​
Accept
enum<string>

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.

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

Query Parameters

​
projectId
string

The unique identifier for the Project.

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Response

Returns an array of Handover Provider objects.

​
items
object[]