Retrieve collection of channelTypes

get

/services/rest/connect/v1.4/channelTypes

Request

Supported Media Types
Query Parameters
  • Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name
  • The requested page size, which limits the number of elements the collection should max return
  • The offset of the page. By default, offset is 0, which means first page will be returned.
  • Returns the count of elements as the given order. The value is a comma delimited string. Each token in the string is the name of the field, optionally followed by asc or desc.
  • Query parameter that allows searching by providing ROQL WHERE clause filtering
  • Indicates whether or not to calculate the totalResults property. By default, totalResults is not calculated.

Response

Supported Media Types

Default Response

Body ()
Collection of channelTypes
Root Schema : channelTypes-collection
Type: object
Collection of channelTypes
Show Source

Examples

Use GET with the following syntax to list all channel types:

https://your_site_interface/services/rest/connect/version/channelTypes

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/channelTypes

Response body example

{
  "items": [
    {
      "id": 1,
      "lookupName": "CSS Email",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/1"
        }
      ]
    },
    {
      "id": 2,
      "lookupName": "MA Email",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/2"
        }
      ]
    },
    {
      "id": 3,
      "lookupName": "Phone",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/3"
        }
      ]
    },
    {
      "id": 4,
      "lookupName": "Fax",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/4"
        }
      ]
    },
    {
      "id": 5,
      "lookupName": "Post",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/5"
        }
      ]
    },
    {
      "id": 6,
      "lookupName": "CSS Web",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/6"
        }
      ]
    },
    {
      "id": 7,
      "lookupName": "MA Web",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/7"
        }
      ]
    },
    {
      "id": 8,
      "lookupName": "Chat",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/8"
        }
      ]
    },
    {
      "id": 9,
      "lookupName": "Email",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/9"
        }
      ]
    },
    {
      "id": 10,
      "lookupName": "Community",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/10"
        }
      ]
    },
    {
      "id": 11,
      "lookupName": "Twitter",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/11"
        }
      ]
    },
    {
      "id": 12,
      "lookupName": "YouTube",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/12"
        }
      ]
    },
    {
      "id": 13,
      "lookupName": "RSS",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/13"
        }
      ]
    },
    {
      "id": 14,
      "lookupName": "Facebook",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/14"
        }
      ]
    },
    {
      "id": 16,
      "lookupName": "SRM Engage",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/16"
        }
      ]
    }
  ],
  "hasMore": false,
  "links": [
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/channelTypes",
      "mediaType": "application/schema+json"
    },
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes"
    }
  ]
}