Add Front to your AI agent

Add teammates to a shift. The selected teammates must be in the team that owns the shift. Requires a Front plan with Shifts.

Add one or more teammates to a team (workspace).

Makes this view visible in specified teammates' sidebar navigation.

Create a Front account with optional domains, external ID, description, and custom fields.

Create a new analytics export of messages or events (activities) over a specific time span. The export will be executed asynchronously. The response will include a link that can be used to retrieve the export status & result. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.

Create a new analytics report for a set of metrics over a specific time span. Different filters (e.g. Inbox v Tag v Teammates) will be joined with AND logic, but the IDs within a filter will be joined with OR logic (e.g. Inbox A or Inbox B, Tag A or Tag B). The report will be executed asynchronously. The response will include a link that can be used to retrieve the report status & result. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.

Create a custom, SMTP, Twilio, or developer-application channel in an existing inbox.

Create a new message template as a child of the given folder

Create a new message template folder as a child of the given folder

Create a company teammate group with an optional description and contact-list permissions.

Create a contact globally or for one team or teammate. Supplying named groups or contact lists also creates any that are missing.

Create a contact list globally or for one team or teammate.

Create a new [conversation](https://dev.frontapp.com/reference/conversations#creating-a-new-conversation) of type discussion or task. Both types only support comments. If you want to create a conversation that supports messages, use the [Create message](https://dev.frontapp.com/reference/post_channels-channel-id-messages) endpoint. If you want to add a comment to an existing conversation, use the [Add comment](https://dev.frontapp.com/reference/post_conversations-conversation-id-comments) endpoint.

Create a draft message which is the first message of a new [conversation](https://dev.frontapp.com/reference/conversations).

Create a new draft as a reply to the last message in the conversation.

Create an inbox in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team inbox](https://dev.frontapp.com/reference/create-team-inbox) endpoint instead.

Create an internal company-only or externally available knowledge base.

Create an article in a knowledge base's default locale or a specified locale.

Create a category in a knowledge base's default locale or a specified locale.

Create a message template globally or for one team.

Create a message-template folder globally or for one team or teammate.

Create a global or team-owned shift; requires a Front plan with Shifts.

Create a standard link from an external URL. If the link resolves to an installed links integration, the integration's name overrides the provided name.

Create a tag globally, company-wide, under a parent tag, or for one team or teammate.

Create a team inbox and optionally configure teammate access, public visibility, and custom fields.

Create a team email signature and optionally configure default status and channel visibility.

Create a team conversation view filtered by inboxes, tags, assignees, and optional exclusions.

Create a teammate-owned message template, optionally inside a message-template folder.

Create a private inbox owned by a specified teammate, with optional custom fields.

Create a teammate email signature and optionally make it the default or limit it to selected channels.

Create a time off for a teammate.

Deletes an account This permanently deletes the resource.

Deletes a teammate group. Note - You cannot delete a teammate group that is managed by SCIM. This permanently deletes the resource.

Delete a contact. This permanently deletes the resource.

Remove a handle from a contact. If `force` is true and this is the last handle, Front permanently deletes the entire contact; this cannot be undone.

Delete a contact lists. This permanently deletes the resource.

Permanently delete a conversation. First use Update conversation to set its status to "deleted"; setting it to "archived" is not sufficient. This action cannot be undone. This permanently deletes the resource.

Delete a draft message. This permanently deletes the resource.

Deletes an article and all its content and translations. This permanently deletes the resource.

Deletes a knowledge base category. This permanently deletes the resource.

Delete a message template This permanently deletes the resource.

Delete a message template folder and child folders/templates This permanently deletes the resource.

Delete signature This permanently deletes the resource.

Delete a tag. This permanently deletes the resource.

Delete a time off. This permanently deletes the resource.

Download one article attachment by article ID and attachment ID.

Download an attachment by its link ID, optionally constrained to its comment, message, or message-template parent.

Retrieve one account by account ID, domain, or external-ID resource alias.

Fetch an analytics exports. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.

Fetch an analytics report. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.

Retrieve one channel by channel ID or channel-address resource alias.

Retrieve one conversation comment by comment ID.

Retrieve one company teammate group by group ID.

Retrieve one contact by contact ID or source-and-handle resource alias.

Retrieve one conversation by conversation ID.

Fetch the details of the API token.

Retrieve one event by event ID.

Retrieve one inbox by inbox ID.

Retrieve knowledge-base metadata without localized content. Use `FRONT_GET_KNOWLEDGE_BASE_CONTENT` to retrieve localized content.

Retrieve article metadata without localized content. Use `FRONT_GET_KNOWLEDGE_BASE_ARTICLE_CONTENT` to retrieve default- or selected-locale content.

Get a knowledge-base article with content in its default locale or a specified locale.

Retrieve category metadata without localized content. Use `FRONT_GET_KNOWLEDGE_BASE_CATEGORY_CONTENT` to retrieve default- or selected-locale content.

Get a knowledge-base category with content in its default locale or a specified locale.

Get a knowledge base with content in its default locale or a specified locale.

Retrieve one Front link by link ID.

Retrieve a message as documented JSON, or download the raw email as an EML file when `response_format` is `eml`.

Get the seen receipts for the given message. If no seen-by information is available, there will be a single entry for the first time the message was seen by any recipient. If seen-by information is available, there will be an entry for each recipient who has seen the message.

Retrieve one message template by template ID.

Fetch a message template folder.

Retrieve one Front automation rule by rule ID.

Fetch a shift. Requires a Front plan with Shifts.

Retrieve one email signature by signature ID.

Retrieve one tag by tag ID.

Fetch a team (workspace).

Retrieve one teammate by teammate ID or email resource alias.

Retrieve one ticket status by status ID.

Retrieve one time-off record by time-off ID.

Retrieve one conversation view by view ID.

Use this endpoint to import conversations into Front without sending data through a channel. Typical use cases include importing historical conversations or creating new conversations from non-standard sources, such as web form submissions that can't use the default Form channel (for example, forms that don't have static URLs or form providers that send email notifications after submission). Avoid using this endpoint for conversations that can be handled by a dedicated Front channel—instead, use the [Create message](https://dev.frontapp.com/reference/create-message) endpoint to send (rather than import) a new message.

Adds conversations to the link group of the conversation in the path, which becomes the original conversation of the group. If it belongs to no group yet, a new one is formed. A conversation belongs to at most one group, and a conversation that was linked to another one cannot become an original conversation.

Lists the contacts associated with an Account

List the accounts of the company.

List categories in a knowledge base.

List channels globally or for one inbox, team, or teammate.

Fetch the child message templates folders of a message template folder.

Fetch the child message templates of a message template folder.

List the teammates mentioned in a comment.

List inboxes that the teammate group has access to via its associated teams.

List teammates belonging to a specified company teammate group.

List teams added to the teammate group. Any teams added to the teammate group will automatically link public inboxes.

List company teammate groups with their IDs, names, SCIM-management status, contact-list permissions, and membership links.

List company ticket statuses with their IDs, names, and categories for resolving valid status IDs.

List contact lists globally or for one team or teammate.

List the notes added to a contact.

List contacts globally or for one team or teammate.

List the contacts belonging to the requested contact list.

List the comments in a conversation in reverse chronological order (newest first).

List draft messages in a conversation with cursor-based pagination.

List the events that occured for a conversation in reverse chronological order (newest first). The order will respect your company's [bump settings](https://help.front.com/t/y729th/customize-when-conversations-bump-up), which determine when conversations bump to the top.

List the teammates following a conversation.

List the inboxes in which a conversation is listed.

List the messages in a conversation in reverse chronological order (newest first).

List the conversations in the company in reverse chronological order (most recently updated first). The order will respect your company's [bump settings](https://help.front.com/t/y729th/customize-when-conversations-bump-up), which determine when conversations bump to the top. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).

List custom-field definitions for a selected Front resource type.

Lists all the detailed events which occurred in the inboxes of the company ordered in reverse chronological order (newest first). Refer to the [Events](https://dev.frontapp.com/reference/events) topic for more information, including sorting and filtering.

List the teammates with access to an inbox.

List the inboxes of the company.

List articles in a knowledge base or in one knowledge-base category.

List the knowledge bases of the company.

List the conversations linked to a specific link. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations). For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.

List the conversations linked to the original conversation in the path. Conversations the requester cannot access are omitted, so a page can hold fewer results than requested while more remain.

List the links of the company paginated by ID. Filter by link type with `filters.types`. These links include application objects; for more details, see the [Links](https://dev.frontapp.com/reference/links) topic.

List message-template folders globally or for one team or teammate.

List message templates globally or for one team or teammate.

List conversations related to one tag, contact, inbox, or teammate.

List rules globally, company-wide, or for one team or teammate.

List shifts globally or for one team or teammate; requires a Front plan with Shifts.

List the teammates assigned to a shift. Requires a Front plan with Shifts.

List signatures owned by one team or teammate.

List the direct child tags beneath a specified parent tag.

List tags globally, company-wide, or for one team or teammate.

List the inboxes belonging to a team (workspace).

List private inboxes owned by a specified teammate.

List all company teammates for teammate discovery and ID resolution.

List the teams (workspaces) in the company.

List time-off records for one team or teammate.

List views globally or for one team.

Mark an outbound message from Front as seen. Note, the message seen route should only be called in response to an actual end-user's message-seen action. In accordance with this behavior, the route is rate limited to 10 requests per message per hour.

Merges the contacts specified into a single contact, deleting the merged-in contacts. If a target contact ID is supplied, the other contacts will be merged into that one. Otherwise, some contact in the contact ID list will be treated as the target contact. Merge conflicts will be resolved in the following ways: * name will prioritize manually-updated and non-private contact names * descriptions will be concatenated and separated by newlines in order from oldest to newest with the (optional) target contact's description first * all handles, groups, links, and notes will be preserved * other conflicts will use the most recently updated contact's value This irreversibly merges contact records.

Receive a custom message in Front. This endpoint is available for custom channels **ONLY**.

Refresh or update existing application objects that match an exact pattern. This does not create new application objects.

Unlinks non-public inboxes from the teammate group.

Remove teammate group teammates. Note - You cannot modify a teammate group that is managed by SCIM.

Remove teams from the teammate group. Unlinks to any associated team inboxes.

Removes a list of contacts from an Account

Remove specified contact IDs or source-and-handle resource aliases from a contact list.

Removes teammates from the list of followers of a conversation.

Removes one or more links to a conversation. For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.

Removes one or more tags to a conversation

Remove access of one or more teammates from an inbox.

Remove teammates from a shift. Requires a Front plan with Shifts.

Remove one or more teammates from a team (workspace).

Reply to a conversation by sending and appending an external message. The conversation can optionally be tagged and archived immediately after sending. Sending cannot be undone.

Search for conversations. Response will include a count of total matches and an array of conversations in descending order by last activity. See the [search syntax documentation](https://dev.frontapp.com/docs/search-1) for usage examples. **Note:** This endpoint is subject to [proportional rate limiting](https://dev.frontapp.com/docs/rate-limiting#additional-proportional-limiting) at 40% of your company's rate limit.

Send a new external message from a channel and create a conversation. The new conversation can optionally be tagged and archived immediately after sending. Sending cannot be undone.

Trigger Front workflows for an application object. This endpoint requires a company API token with the Application Triggers permission and cannot be used with Front app OAuth tokens.

Update an account's name, description, domains, or custom fields.

Update a channel's name or settings, or move it to another inbox together with its conversations.

Update a comment in a [conversation](https://dev.frontapp.com/reference/conversations).

Updates a teammate group. Note - You cannot modify a teammate group that is managed by SCIM.

Update a contact's profile, links, list memberships, and custom fields; missing named groups may be created.

Update a conversation's assignee, inbox, status, tags, task details, due date, or custom fields.

Assign or unassign a conversation.

Snooze or unsnooze a conversation for the provided user. For private conversations, reminders can only be created and edited through the API for teammates that own the conversation. For shared conversations, reminders created and edited through the API are shared for all teammates within the shared inbox(es) that the conversation belongs to.

Update an existing shared draft's body, recipients, channel, attachments, signature, subject, and version.

Update article content in its default locale or a specified locale.

Update category content in its default locale or a specified locale.

Update knowledge-base content in its default locale or a specified locale.

Rename an existing Front link.

Update a message template's name, subject, body, parent folder, inbox availability, or attachments.

Update message template folder

Update a shift. Requires a Front plan with Shifts.

Update a signature's name, sender information, body, visibility, default status, or channel availability.

Update a tag's name, description, color, parent, or conversation-list visibility.

Update a teammate's username, name, availability, or custom fields.

Update a time-off record's name, dates, or auto-responder settings.

Update a conversation view's name, inbox filters, tag filters, assignee filters, exclusions, no-tag setting, or highlight color.

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](https://dev.frontapp.com/reference/post_inboxes-inbox-id-channels) with type smtp and the send_as set to the needed email address. You then [configure the email provider](https://help.front.com/en/articles/2081), after which you use this endpoint to asynchronously validate the SMTP settings.