Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Channels

Get channel

Fetch a channel.

Required scope: channels:read

get/channels/{channel_id}

Path parameters

channel_idstring required

The Channel ID. Alternatively, you can supply the channel address as a resource alias.

Response

A channel

idstring required

Unique identifier for the channel

namestring

The name of the channel

addressstring

Address receiving the messages

type'custom' | 'facebook' | 'gmail' | 'google_play' | 'imap' | 'intercom' | 'form' | 'office365' | 'layer_anon' | 'smtp' | 'talkdesk' | 'truly' | 'twilio' | 'twilio_whatsapp' | 'twitter' | 'twitter_dm' | 'yalo_wha' | 'front_chat' | 'front_mail' required

Type of the channel

send_asstring

Address which appears as the sender for messages sent from Front

is_privateboolean required

Whether or not the channel is individual

is_validboolean required

Whether or not the channel configuration is valid

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/channels/cha_1gv4",
    "related": {
      "inbox": "https://yourCompany.api.frontapp.com/inboxes/inb_1ix6",
      "owner": "https://yourCompany.api.frontapp.com/teams/jen_k30"
    }
  },
  "id": "cha_1gv4",
  "name": "Paper Sales Inbox",
  "address": "sales@dundermifflin.com",
  "type": "gmail",
  "send_as": "sales@dundermifflin.com",
  "settings": {
    "undo_send_time": 15
  },
  "is_valid": true
}