FrontApp Channels API
The Channels API from FrontApp — 6 operation(s) for channels.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/frontapp:frontapp-channels-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Frontapp Channels API
version: 1.0.0
contact:
name: Front Platform
url: https://community.front.com
description: 'Operations tagged Channels across 2 of this provider''s published API definitions: frontapp-channel-api-openapi.yml, frontapp-core-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api2.frontapp.com
security:
- http: []
tags:
- name: Channels
paths:
/channels/{channel_id}:
patch:
summary: Update Channel
operationId: update-channel
description: Update a channel.
tags:
- Channels
parameters:
- in: path
name: channel_id
required: true
description: The Channel ID. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1).
schema:
type: string
default: cha_123
requestBody:
required: true
description: Channel details
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateChannel'
responses:
'204':
description: No content
x-required-scopes:
- channels:write
get:
summary: Get channel
operationId: get-channel
description: 'Fetch a channel.
Required scope: `channels:read`'
tags:
- Channels
parameters:
- in: path
name: channel_id
required: true
description: The Channel ID. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1).
schema:
type: string
default: cha_123
responses:
'200':
$ref: '#/components/responses/channel'
x-required-scopes:
- channels:read
servers:
- url: https://api2.frontapp.com
/channels:
get:
summary: List channels
operationId: list-channels
description: 'List the channels of the company.
Required scope: `channels:read`'
tags:
- Channels
responses:
'200':
$ref: '#/components/responses/listOfChannels'
x-required-scopes:
- channels:read
servers:
- url: https://api2.frontapp.com
/channels/{channel_id}/validate:
post:
summary: Validate channel
operationId: validate-channel
description: 'Asynchronously validate an SMTP channel (this endpoint is irrelevant to other channel types). When you create an SMTP channel via the API, create a channel with type smtp and the send_as set to the needed email address. You then configure the email provider, after which you use this endpoint to asynchronously validate the SMTP settings.
Required scope: `channels:write`'
tags:
- Channels
parameters:
- in: path
name: channel_id
required: true
description: The Channel ID. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1).
schema:
type: string
default: cha_123
responses:
'202':
$ref: '#/components/responses/accepted'
x-required-scopes:
- channels:write
servers:
- url: https://api2.frontapp.com
/inboxes/{inbox_id}/channels:
post:
summary: Create a channel
operationId: create-a-channel
description: 'Create a channel in an inbox.
Required scope: `channels:write`'
tags:
- Channels
parameters:
- in: path
name: inbox_id
required: true
description: The Inbox ID
schema:
type: string
default: inb_123
requestBody:
required: true
description: Channel to create
content:
application/json:
schema:
$ref: '#/components/schemas/CreateChannel'
responses:
'204':
description: No content
x-required-scopes:
- channels:write
servers:
- url: https://api2.frontapp.com
/teammates/{teammate_id}/channels:
get:
summary: List teammate channels
operationId: list-teammate-channels
description: 'List the channels of a teammate.
Required scope: `channels:read`'
tags:
- Channels
parameters:
- in: path
name: teammate_id
required: true
description: The teammate ID. Alternatively, you can supply an email as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1).
schema:
type: string
default: tea_123
responses:
'200':
$ref: '#/components/responses/listOfChannels'
x-required-scopes:
- channels:read
servers:
- url: https://api2.frontapp.com
/teams/{team_id}/channels:
get:
summary: List team channels
operationId: list-team-channels
description: 'List the channels of a team (workspace).
Required scope: `channels:read`'
tags:
- Channels
parameters:
- in: path
name: team_id
required: true
description: The team ID
schema:
type: string
default: tim_123
responses:
'200':
$ref: '#/components/responses/listOfChannels'
x-required-scopes:
- channels:read
servers:
- url: https://api2.frontapp.com
components:
schemas:
UpdateChannel:
properties:
status:
type: string
description: Status of the channel
enum:
- offline
- ok
ChannelResponse:
type: object
required:
- _links
- id
- type
- settings
- is_private
- is_valid
properties:
_links:
type: object
properties:
self:
type: string
description: Link to resource
example: https://yourCompany.api.frontapp.com/channels/cha_1gv4
related:
type: object
properties:
inbox:
type:
- string
- 'null'
description: Link to channel inbox
example: https://yourCompany.api.frontapp.com/inboxes/inb_1ix6
owner:
type: string
description: Link to channel owner
example: https://yourCompany.api.frontapp.com/teams/jen_k30
id:
type: string
description: Unique identifier for the channel
example: cha_1gv4
name:
type: string
description: The name of the channel
example: Paper Sales Inbox
address:
type: string
description: Address receiving the messages
example: sales@dundermifflin.com
type:
type: string
description: Type of the channel
enum:
- 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
example: gmail
send_as:
type: string
description: Address which appears as the sender for messages sent from Front
example: sales@dundermifflin.com
settings:
type: object
description: Channel settings
properties:
undo_send_time:
type: integer
description: The time (measured in seconds) that users have to undo a send operation in the channel.
enum:
- 0
- 5
- 10
- 15
- 30
- 60
example: 15
all_teammates_can_reply:
type: boolean
description: Whether teammates without inbox access can reply on this channel. Only present for shared channels; omitted for private channels.
example: false
is_private:
type: boolean
default: false
description: Whether or not the channel is individual
example: false
is_valid:
type: boolean
default: false
description: Whether or not the channel configuration is valid
example: true
CreateChannel:
required:
- type
properties:
name:
type: string
description: Name of the channel
settings:
type: object
description: Settings of the channel
properties:
undo_send_time:
type: integer
description: The time (measured in seconds) that users have to undo a send operation in the channel.
enum:
- 0
- 5
- 10
- 15
- 30
- 60
all_teammates_can_reply:
type: boolean
description: Whether teammates without inbox access can reply on this channel. Only allowed for shared channels.
webhook_url:
type: string
description: The webhook URL outbound messages should be sent to. Only allowed for "custom" type channels.
sid:
type: string
description: The SID of the Twilio channel. Only allowed for "twilio" type channels.
auth_token:
type: string
description: The auth token for the Twilio account. Only allowed for "twilio" type channels.
type:
type: string
description: Type of the channel
enum:
- custom
- smtp
- twilio
send_as:
type: string
description: Sending address of your channel. Required for SMTP and Twilio channels.
application_uid:
type: string
description: 'The UID of a developer app that defines a channel. When provided, an application
channel bound to that app is created (the channel `type` must be "custom").
'
credentials:
type: object
description: "Credentials used to authenticate requests to the application's service. Only used with\n`application_uid`, and its shape depends on the application server's authentication type:\n - `none`: omit.\n - `api_key`: `{ \"api_key\": string }`.\n - `basic`: `{ \"username\": string, \"password\": string }`.\n - `bearer`: `{ \"access_token\": string }`.\n - OAuth2 `client_credentials`: `{ \"client_id\": string, \"client_secret\": string }`\n - OAuth2 `password`: `{ \"username\": string, \"password\": string }`\n - OAuth2 `authorization_code`: omit. The channel is created unauthenticated and the OAuth\n flow must be completed interactively afterwards.\n"
responses:
listOfChannels:
description: Array of Channels
content:
application/json:
schema:
type: object
properties:
_links:
type: object
properties:
self:
type: string
description: Link to resource
example: https://yourCompany.api.frontapp.com/channels
_results:
type: array
items:
$ref: '#/components/schemas/ChannelResponse'
channel:
description: A channel
content:
application/json:
schema:
$ref: '#/components/schemas/ChannelResponse'
accepted:
description: Request accepted
content:
application/json:
schema:
type: object
properties:
status:
type: string
default: accepted
example: accepted
securitySchemes:
http:
type: http
scheme: bearer
bearerFormat: JWT
x-refined-from:
- frontapp-channel-api-openapi.yml
- frontapp-core-api-openapi.yml
x-api-id: front
x-explorer-enabled: false
x-proxy-enabled: true
x-samples-enabled: true
x-provenance:
method: searched
source: https://dev.frontapp.com/reference
harvested: '2026-10-14'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://dev.frontapp.com/reference/add-call-recording.md
- https://dev.frontapp.com/reference/add-call-summary.md
- https://dev.frontapp.com/reference/add-call-transcript.md
- https://dev.frontapp.com/reference/create-call.md
- https://dev.frontapp.com/reference/delete-application-message-template.md
- https://dev.frontapp.com/reference/sync-application-message-template.md
- https://dev.frontapp.com/reference/sync-inbound-message.md
- https://dev.frontapp.com/reference/sync-outbound-message.md
- https://dev.frontapp.com/reference/update-application-message-template.md
- https://dev.frontapp.com/reference/update-call.md
- https://dev.frontapp.com/reference/update-channel-1.md
- https://dev.frontapp.com/reference/update-external-message-status.md
merge:
pages: 12
deduped: 15
conflicts_kept_first: 0