v1

latestOpenAPI 3.0.02026-07-1315476656.4 KB

CommunicationWay

Retrieve communication ways

Returns all communication ways which have been added up until now. Filters can be added.

get/CommunicationWay

Query parameters

contact[id]string

ID of contact for which you want the communication ways.

contact[objectName]string

Example:Contact

Object name. Only needed if you also defined the ID of a contact.

type'PHONE' | 'EMAIL' | 'WEB' | 'MOBILE'

Type of the communication ways you want to get.

main'0' | '1'

Define if you only want the main communication way.

Response

Successful operation

Example response

{
  "objects": [
    {
      "id": "0",
      "objectName": "CommunicationWay",
      "contact": {
        "id": "0",
        "objectName": "Contact"
      },
      "type": "EMAIL",
      "key": {
        "id": "0",
        "objectName": "CommunicationWayKey"
      },
      "main": "0",
      "sevClient": {
        "id": "0",
        "objectName": "SevClient"
      }
    }
  ]
}