Show Developer Menu

GET /channels

Issuing a GET call to channels will allow you to retrieve channels for the Brand

Example Request
curl 'https://{brand}.reamaze.com/api/v1/channels' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json'
Example Response
{
  "total_count": 10,
  "channels": [
    {
      "name": "Support",
      "slug": "support",
      "email": "support@example.reamaze.com",
      "created_at": "2015-08-21T04:39:23.000Z",
      "updated_at": "2015-08-21T04:39:23.000Z",
      "channel": 1,
      "visibility": 0,
      "spam_filter_enabled": false,
      "reply_from_origin": false,
      "verified": true,
      "verification_email": "hello@example.com",
      "last_verified": "2015-08-21T04:39:23.000Z",
      "settings_reply_from_name": "channel",
      "settings_signature": "- Example Signature",
      "brand": {
        "name": "Example",
        "url": "example"
      }
    }
    ...
  ]
}
Optional Params
  • channel with email, facebook, twitter, or chat will show only channels by the respective types.
Notes
  • The channel value denotes the channel type:
    • 1 - Email
    • 2 - Twitter
    • 3 - Facebook
    • 6 - Chat
  • The visibility value denotes the channel visibility: 0 (Private), 1 (Public)
  • The settings_reply_from_name value determines the whether the "From" name for replies is set to the channel name ("channel") or the responding staff user's name ("staff")