# Front Platform Documentation > Documentation for Front Platform ## Guides - [Welcome](https://dev.frontapp.com/docs/welcome.md) - [Partnering With Front](https://dev.frontapp.com/docs/partnering-with-front.md) - [Create, manage, and publish apps](https://dev.frontapp.com/docs/create-and-manage-apps.md) - [Join our Developer Community](https://dev.frontapp.com/docs/join-our-developer-community.md) - [Overview](https://dev.frontapp.com/docs/core-api-overview.md) - [Authentication](https://dev.frontapp.com/docs/authentication.md) - [OAuth](https://dev.frontapp.com/docs/oauth.md) - [API tokens](https://dev.frontapp.com/docs/create-and-revoke-api-tokens.md) - [Base URL](https://dev.frontapp.com/docs/base-url.md) - [Rate limits](https://dev.frontapp.com/docs/rate-limiting.md) - [Search](https://dev.frontapp.com/docs/search-1.md) - [Resource Aliases](https://dev.frontapp.com/docs/resource-aliases-1.md) - [Attachments](https://dev.frontapp.com/docs/attachments-1.md) - [Webhooks](https://dev.frontapp.com/docs/webhooks-1.md) - [Application webhooks](https://dev.frontapp.com/docs/application-webhooks.md) - [Rule webhooks](https://dev.frontapp.com/docs/rule-webhooks.md) - [Application Triggers](https://dev.frontapp.com/docs/application-triggers.md) - [Tools](https://dev.frontapp.com/docs/tools.md) - [MCP Server](https://dev.frontapp.com/docs/mcp-server.md) - [Overview](https://dev.frontapp.com/docs/plugin-overview.md) - [Plugin Terminology 101](https://dev.frontapp.com/docs/plugin-terminology-101.md) - [Open a sidebar plugin from a URL](https://dev.frontapp.com/docs/open-a-sidebar-plugin-from-a-url.md) - [Tools](https://dev.frontapp.com/docs/tools-1.md) - [Auth0 - React - Vite template plugin](https://dev.frontapp.com/docs/auth0-react-vite-template-plugin.md) - [Build plugins easily with AI](https://dev.frontapp.com/docs/ai-prompt-for-scaffolding-plugins.md) - [AI Prompt File](https://dev.frontapp.com/docs/ai-prompt-file.md): v0.2 - [Overview](https://dev.frontapp.com/docs/channels-overview.md) - [Fundamentals of Application Channels](https://dev.frontapp.com/docs/creating-a-partner-channel.md) - [Token instrospection for channel identification](https://dev.frontapp.com/docs/token-instrospection-for-channel-identification.md) - [Voice channels](https://dev.frontapp.com/docs/voice-channels.md) - [Application Channel Message Templates](https://dev.frontapp.com/docs/application-channel-message-templates.md) - [Creating a Custom Channel](https://dev.frontapp.com/docs/creating-a-custom-channel.md) - [Tools](https://dev.frontapp.com/docs/tools-2.md) - [Overview](https://dev.frontapp.com/docs/overview-2.md) - [Security](https://dev.frontapp.com/docs/security-1.md) - [Sample applications](https://dev.frontapp.com/docs/sample-applications-1.md) - [Basic application object handler](https://dev.frontapp.com/docs/basic-dynamic-object-handler.md) - [No-code application object](https://dev.frontapp.com/docs/no-code-dynamic-object.md) - [Creating new API records using Connectors and App Triggers](https://dev.frontapp.com/docs/creating-new-api-records-using-connectors-and-app-triggers.md) - [Connectors Academy course](https://dev.frontapp.com/docs/connectors-academy-course.md) - [Connectors Community space](https://dev.frontapp.com/docs/connectors-community-space.md) - [Overview](https://dev.frontapp.com/docs/overview-1.md) - [Overview](https://dev.frontapp.com/docs/chat-overview.md) - [Chat Widget SDK Reference](https://dev.frontapp.com/docs/chat-sdk-reference.md) - [Install the Chat Widget in an iOS app](https://dev.frontapp.com/docs/install-the-chat-widget-in-an-ios-app.md) - [Install the Chat Widget in an Android app](https://dev.frontapp.com/docs/install-the-chat-widget-in-an-android-app.md) - [Identify users](https://dev.frontapp.com/docs/identify-users.md) - [Content Security Policy](https://dev.frontapp.com/docs/content-security-policy.md) - [Sample applications](https://dev.frontapp.com/docs/sample-applications-2.md) - [Overview](https://dev.frontapp.com/docs/overview-3.md) - [Autopilot Resolve SDK Reference](https://dev.frontapp.com/docs/autopilot-resolve-sdk-reference.md) ## API Reference - [Introduction](https://dev.frontapp.com/reference/introduction.md) - [Response Body Structure](https://dev.frontapp.com/reference/response-body-structure.md) - [API Terminology 101](https://dev.frontapp.com/reference/api-terminology-101.md) - [List Accounts](https://dev.frontapp.com/reference/list-accounts.md): List the accounts of the company. Required scope: `accounts:read` - [Create account](https://dev.frontapp.com/reference/create-account.md): Create a new account. Required scope: `accounts:write` - [Fetch an account](https://dev.frontapp.com/reference/fetch-an-account.md): Fetches an account Required scope: `accounts:read` - [Update account](https://dev.frontapp.com/reference/update-account.md): Updates an account. Required scope: `accounts:write` - [Delete an account](https://dev.frontapp.com/reference/delete-an-account.md): Deletes an account Required scope: `accounts:delete` - [List account contacts](https://dev.frontapp.com/reference/list-account-contacts.md): Lists the contacts associated with an Account Required scope: `contacts:read` - [Add contact to Account](https://dev.frontapp.com/reference/add-contact-to-account.md): Adds a list of contacts to an Account Required scope: `accounts:write` - [Remove contact from Account](https://dev.frontapp.com/reference/remove-contact-from-account.md): Removes a list of contacts from an Account Required scope: `accounts:write` - [Custom Fields](https://dev.frontapp.com/reference/custom-fields.md) - [List Account's custom fields](https://dev.frontapp.com/reference/list-account-custom-fields.md): Lists the custom fields that can be attached to an Account. Required scope: `custom_fields:read` - [List Contact's custom fields](https://dev.frontapp.com/reference/list-contact-custom-fields.md): Lists the custom fields that can be attached to a Contact. Required scope: `custom_fields:read` - [List Conversation's custom fields](https://dev.frontapp.com/reference/list-conversation-custom-fields.md): Lists the custom fields that can be attached to a Conversation. Required scope: `custom_fields:read` - [List Contact's custom fields](https://dev.frontapp.com/reference/list-custom-fields.md): Lists the custom fields that can be attached to a Contact. > ⚠️ Deprecated endpoint > > This endpoint has been deprecated. Please use the fully compatible `GET /contacts/custom_fields` endpoint instead. Required scope: `custom_fields:read` - [List Inbox's custom fields](https://dev.frontapp.com/reference/list-inbox-custom-fields.md): Lists the custom fields that can be attached to an Inbox. Required scope: `custom_fields:read` - [List Link's custom fields](https://dev.frontapp.com/reference/list-link-custom-fields.md): Lists the custom fields that can be attached to a Link. For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic. Required scope: `custom_fields:read` - [List Teammate's custom fields](https://dev.frontapp.com/reference/list-teammate-custom-fields.md): Lists the custom fields that can be attached to a Teammate. Required scope: `custom_fields:read` - [Analytics](https://dev.frontapp.com/reference/analytics.md) - [Create a new analytics export](https://dev.frontapp.com/reference/create-analytics-export.md): 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. Required scope: `analytics:read` - [Fetch an analytics export](https://dev.frontapp.com/reference/get-analytics-export.md): Fetch an analytics exports. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics. Required scope: `analytics:read` - [Create a new analytics report](https://dev.frontapp.com/reference/create-analytics-report.md): 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. Required scope: `analytics:read` - [Fetch an analytics report](https://dev.frontapp.com/reference/get-analytics-report.md): Fetch an analytics report. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics. Required scope: `analytics:read` - [Trigger application event](https://dev.frontapp.com/reference/trigger-app-event.md): Triggers an event on behalf of an application. These events can trigger Front workflows, like rules. For more information, see the [developer docs](https://dev.frontapp.com/docs/application-triggers#/). Required scope: `feature:app_trigger` - [Channels](https://dev.frontapp.com/reference/channels.md) - [List channels](https://dev.frontapp.com/reference/list-channels.md): List the channels of the company. Required scope: `channels:read` - [Get channel](https://dev.frontapp.com/reference/get-channel.md): Fetch a channel. Required scope: `channels:read` - [Update Channel](https://dev.frontapp.com/reference/update-channel.md): Update a channel. Required scope: `channels:write` - [Validate channel](https://dev.frontapp.com/reference/validate-channel.md): 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. Required scope: `channels:write` - [Create a channel](https://dev.frontapp.com/reference/create-a-channel.md): Create a channel in an inbox. Required scope: `channels:write` - [List teammate channels](https://dev.frontapp.com/reference/list-teammate-channels.md): List the channels of a teammate. Required scope: `channels:read` - [List team channels](https://dev.frontapp.com/reference/list-team-channels.md): List the channels of a team (workspace). Required scope: `channels:read` - [Drafts](https://dev.frontapp.com/reference/drafts.md) - [Create draft](https://dev.frontapp.com/reference/create-draft.md): Create a draft message which is the first message of a new [conversation](https://dev.frontapp.com/reference/conversations). Required scope: `drafts:write` - [List conversation drafts](https://dev.frontapp.com/reference/list-conversation-drafts.md): List the drafts in a conversation. Required scope: `drafts:read` - [Create draft reply](https://dev.frontapp.com/reference/create-draft-reply.md): Create a new draft as a reply to the last message in the conversation. Required scope: `drafts:write` - [Delete draft](https://dev.frontapp.com/reference/delete-draft.md): Delete a draft message. Required scope: `drafts:delete` - [Edit draft](https://dev.frontapp.com/reference/edit-draft.md): Edit a draft message. Required scope: `drafts:write` - [Messages](https://dev.frontapp.com/reference/messages.md) - [Receive custom messages](https://dev.frontapp.com/reference/receive-custom-messages.md): Receive a custom message in Front. This endpoint is available for custom channels **ONLY**. Required scope: `messages:write` - [Create message](https://dev.frontapp.com/reference/create-message.md): Send a new message from a channel. This is one of the ways to create a new [conversation](https://dev.frontapp.com/reference/conversations#creating-a-new-conversation). The new conversation will support both messages and comments (discussions). Required scope: `messages:send` - [Create message reply](https://dev.frontapp.com/reference/create-message-reply.md): Reply to a conversation by sending a message and appending it to the conversation. Required scope: `messages:send` - [Import message](https://dev.frontapp.com/reference/import-inbox-message.md): 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. Required scope: `messages:write` - [Get message](https://dev.frontapp.com/reference/get-message.md): Fetch a message. > ℹ️ The HTTP Header `Accept` can be used to request the message in a different format. > By default, Front will return the documented JSON response. By requesting `message/rfc822`, the response will contain the message in the EML format (for email messages only). Required scope: `messages:read` - [Get message seen status](https://dev.frontapp.com/reference/get-message-seen-status.md): 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. Required scope: `messages:read` - [Mark message seen](https://dev.frontapp.com/reference/mark-message-seen.md): 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. Required scope: `messages:write` - [Comments](https://dev.frontapp.com/reference/comments.md) - [Get comment](https://dev.frontapp.com/reference/get-comment.md): Fetches a comment. Required scope: `comments:read` - [Update comment](https://dev.frontapp.com/reference/update-comment.md): Update a comment in a [conversation](https://dev.frontapp.com/reference/conversations). Required scope: `comments:write` - [List comment mentions](https://dev.frontapp.com/reference/list-comment-mentions.md): List the teammates mentioned in a comment. Required scope: `teammates:read` - [List conversation comments](https://dev.frontapp.com/reference/list-conversation-comments.md): List the comments in a conversation in reverse chronological order (newest first). Required scope: `comments:read` - [Add comment](https://dev.frontapp.com/reference/add-comment.md): Add a comment to a [conversation](https://dev.frontapp.com/reference/conversations). If you want to create a new comment-only conversation, use the [Create discussion conversation](https://dev.frontapp.com/reference/create-conversation) endpoint. Required scope: `comments:write` - [Add comment reply](https://dev.frontapp.com/reference/add-comment-reply.md): Add a reply to a comment on a [conversation](https://dev.frontapp.com/reference/conversations). Comment replies visually indicate which comment is being responded to, helping users follow the conversation. Required scope: `comments:write` - [Attachments](https://dev.frontapp.com/reference/attachments.md) - [Download attachment for a comment](https://dev.frontapp.com/reference/download-attachment-for-a-comment.md): Download an attachment file for a given comment ID Required scope: `attachments:read` - [Download attachment](https://dev.frontapp.com/reference/download-attachment.md): Download an attachment file. Required scope: `attachments:read` - [Download attachment for a message template](https://dev.frontapp.com/reference/download-attachment-for-a-message-template.md): Download an attachment file for a given message template ID Required scope: `attachments:read` - [Download attachment for a message](https://dev.frontapp.com/reference/download-attachment-for-a-message.md): Download an attachment file for a given message id. Should be used by partner channels. Required scope: `attachments:read` - [Rules](https://dev.frontapp.com/reference/rules.md) - [List all company rules](https://dev.frontapp.com/reference/list-all-company-rules.md): List the company rules. Required scope: `rules:read` - [List rules](https://dev.frontapp.com/reference/list-rules.md): List the rules of the company. Required scope: `rules:read` - [Get rule](https://dev.frontapp.com/reference/get-rule.md): Fetch a rule. Required scope: `rules:read` - [List teammate rules](https://dev.frontapp.com/reference/list-teammate-rules.md): List the rules of a teammate. Required scope: `rules:read` - [List team rules](https://dev.frontapp.com/reference/list-team-rules.md): List the rules of a team (workspace). Required scope: `rules:read` - [Statuses](https://dev.frontapp.com/reference/statuses.md) - [List company ticket statuses](https://dev.frontapp.com/reference/list-company-ticket-statuses.md): List the ticket statuses available for your company. Required scope: `statuses:read` - [Get ticket status](https://dev.frontapp.com/reference/get-ticket-status-by-id.md): Fetch a ticket status. Required scope: `statuses:read` - [Tags](https://dev.frontapp.com/reference/tags.md) - [List company tags](https://dev.frontapp.com/reference/list-company-tags.md): List the company tags. Required scope: `tags:read` - [Create company tag](https://dev.frontapp.com/reference/create-company-tag.md): Create a company tag. Required scope: `tags:write` - [List tags](https://dev.frontapp.com/reference/list-tags.md): List all the tags of the company that the API token has access to, whether they be company tags, team tags, or teammate tags. Required scope: `tags:read` - [Create tag](https://dev.frontapp.com/reference/create-tag.md): Create a tag in the oldest team (workspace). This is a legacy endpoint. Use the Create company tag, Create team tag, or Create teammate tag endpoints instead. Required scope: `tags:write` - [Get tag](https://dev.frontapp.com/reference/get-tag.md): Fetch a tag. Required scope: `tags:read` - [Update a tag](https://dev.frontapp.com/reference/update-a-tag.md): Update a tag. Required scope: `tags:write` - [Delete tag](https://dev.frontapp.com/reference/delete-tag.md): Delete a tag. Required scope: `tags:delete` - [List tag children](https://dev.frontapp.com/reference/list-tag-children.md): List the children of a specific tag. Required scope: `tags:read` - [Create child tag](https://dev.frontapp.com/reference/create-child-tag.md): Creates a child tag. Required scope: `tags:write` - [List tagged conversations](https://dev.frontapp.com/reference/list-tagged-conversations.md): List the conversations tagged with a tag. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations). Required scope: `conversations:read` - [List teammate tags](https://dev.frontapp.com/reference/list-teammate-tags.md): List the tags for a teammate. Required scope: `tags:read` - [Create teammate tag](https://dev.frontapp.com/reference/create-teammate-tag.md): Create a tag for a teammate. Required scope: `tags:write` - [List team tags](https://dev.frontapp.com/reference/list-team-tags.md): List the tags for a team (workspace). Required scope: `tags:read` - [Create team tag](https://dev.frontapp.com/reference/create-team-tag.md): Create a tag for a team (workspace). Required scope: `tags:write` - [Contact Groups](https://dev.frontapp.com/reference/contact-groups.md) - [List groups](https://dev.frontapp.com/reference/list-groups.md): List the contact groups. > ⚠️ Deprecated endpoint > > This endpoint has been deprecated. Please use the compatible contact list endpoints instead. > - `GET /contact_lists`. Required scope: `contacts:read` - [Create group](https://dev.frontapp.com/reference/create-group.md): Create a new contact group in the default team (workspace). > ⚠️ Deprecated endpoint > > This endpoint has been deprecated. Please use the compatible contact list endpoints instead. > - `POST /contact_lists`. Required scope: `contacts:write` - [Delete group](https://dev.frontapp.com/reference/delete-group.md): Delete a contact group. > ⚠️ Deprecated endpoint > > This endpoint has been deprecated. Please use the compatible contact list endpoints instead. > - `DELETE /contact_lists/{contact_list_id}`. Required scope: `contacts:delete` - [List contacts in group](https://dev.frontapp.com/reference/list-contacts-in-group.md): List the contacts belonging to the requested group. > ⚠️ Deprecated endpoint > > This endpoint has been deprecated. Please use the compatible contact list endpoints instead. > - `GET /contact_lists/{contact_list_id}/contacts`. Required scope: `contacts:read` - [Add contacts to group](https://dev.frontapp.com/reference/add-contacts-to-group.md): Add contacts to the requested group. > ⚠️ Deprecated endpoint > > This endpoint has been deprecated. Please use the compatible contact list endpoints instead. > - `POST /contact_lists/{contact_list_id}/contacts`. Required scope: `contacts:write` - [Remove contacts from group](https://dev.frontapp.com/reference/remove-contacts-from-group.md): Remove contacts from the requested group. > ⚠️ Deprecated endpoint > > This endpoint has been deprecated. Please use the compatible contact list endpoints instead. > - `DELETE /contact_lists/{contact_list_id}/contacts`. Required scope: `contacts:write` - [List teammate groups](https://dev.frontapp.com/reference/list-teammate-groups.md): List the contact groups belonging to the requested teammate. > ⚠️ Deprecated endpoint > > This endpoint has been deprecated. Please use the compatible contact list endpoints instead. > - `GET /teammates/{teammate_id}/contact_lists`. Required scope: `contacts:read` - [Create teammate group](https://dev.frontapp.com/reference/create-teammate-group.md): Create a new contact group for the requested teammate. > ⚠️ Deprecated endpoint > > This endpoint has been deprecated. Please use the compatible contact list endpoints instead. > - `POST /teammates/{teammate_id}/contact_lists`. Required scope: `contacts:write` - [List team groups](https://dev.frontapp.com/reference/list-team-groups.md): List contact groups belonging to the requested team (workspace). > ⚠️ Deprecated endpoint > > This endpoint has been deprecated. Please use the compatible contact list endpoints instead. > - `GET /teams/{team_id}/contact_lists`. Required scope: `contacts:read` - [Create team group](https://dev.frontapp.com/reference/create-team-group.md): Create a new contact group for the requested team (workspace). > ⚠️ Deprecated endpoint > > This endpoint has been deprecated. Please use the compatible contact list endpoints instead. > - `POST /teams/{team_id}/contact_lists`. Required scope: `contacts:write` - [Contact Lists](https://dev.frontapp.com/reference/contact-lists.md) - [List contact lists](https://dev.frontapp.com/reference/list-contact-lists.md): List contact lists. Required scope: `contacts:read` - [Create contact list](https://dev.frontapp.com/reference/create-contact-list.md): Create a new contact list in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team contact list](https://dev.frontapp.com/reference/create-team-contact-list) endpoint instead. Required scope: `contacts:write` - [Delete contact list](https://dev.frontapp.com/reference/delete-contact-list.md): Delete a contact lists. Required scope: `contacts:delete` - [List contacts in contact list](https://dev.frontapp.com/reference/list-contacts-in-contact-list.md): List the contacts belonging to the requested contact list. Required scope: `contacts:read` - [Add contacts to contact list](https://dev.frontapp.com/reference/add-contacts-to-contact-list.md): Add contacts to the requested contact list. Required scope: `contacts:write` - [Remove contacts from contact list](https://dev.frontapp.com/reference/remove-contacts-from-contact-list.md): Remove contacts from the requested contact list. Required scope: `contacts:write` - [List teammate contact lists](https://dev.frontapp.com/reference/list-teammate-contact-lists.md): List the contact lists belonging to the requested teammate. Required scope: `contacts:read` - [Create teammate contact list](https://dev.frontapp.com/reference/create-teammate-contact-list.md): Create a new contact list for the requested teammate. Required scope: `contacts:write` - [List team contact lists](https://dev.frontapp.com/reference/list-team-contact-lists.md): List contact lists belonging to the requested team (workspace). Required scope: `contacts:read` - [Create team contact list](https://dev.frontapp.com/reference/create-team-contact-list.md): Create a new contact list for the requested team (workspace). Required scope: `contacts:write` - [Contacts](https://dev.frontapp.com/reference/contacts.md) - [List contacts](https://dev.frontapp.com/reference/list-contacts.md): List the contacts of the company. Required scope: `contacts:read` - [Create contact](https://dev.frontapp.com/reference/create-contact.md): Create a new contact at the company level. Required scope: `contacts:write` - [Merge contacts](https://dev.frontapp.com/reference/merge-contacts.md): 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 Required scope: `contacts:write` - [Get contact](https://dev.frontapp.com/reference/get-contact.md): Fetch a contact. Required scope: `contacts:read` - [Update a contact](https://dev.frontapp.com/reference/update-a-contact.md): Updates a contact. Required scope: `contacts:write` - [Delete a contact](https://dev.frontapp.com/reference/delete-a-contact.md): Delete a contact. Required scope: `contacts:delete` - [List contact conversations](https://dev.frontapp.com/reference/list-contact-conversations.md): List the conversations for a contact in reverse chronological order (newest first). For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations). Required scope: `conversations:read` - [List teammate contacts](https://dev.frontapp.com/reference/list-teammate-contacts.md): List the contacts of a teammate. Required scope: `contacts:read` - [Create teammate contact](https://dev.frontapp.com/reference/create-teammate-contact.md): Create a contact for a teammate. Required scope: `contacts:write` - [List team contacts](https://dev.frontapp.com/reference/list-team-contacts.md): List the contacts of a team (workspace). Required scope: `contacts:read` - [Create team contact](https://dev.frontapp.com/reference/create-team-contact.md): Create a contact for a team (workspace). Required scope: `contacts:write` - [Add contact handle](https://dev.frontapp.com/reference/add-contact-handle.md): Adds a new handle to a contact. Required scope: `contacts:write` - [Delete contact handle](https://dev.frontapp.com/reference/delete-contact-handle.md): Remove a handle from a contact. Required scope: `contacts:write` - [List notes](https://dev.frontapp.com/reference/list-notes.md): List the notes added to a contact. Required scope: `contacts:read` - [Add note](https://dev.frontapp.com/reference/add-note.md): Create a new note on a contact. Required scope: `contacts:write` - [Conversations](https://dev.frontapp.com/reference/conversations.md) - [List conversations](https://dev.frontapp.com/reference/list-conversations.md): 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). Required scope: `conversations:read` - [Create discussion/task conversation](https://dev.frontapp.com/reference/create-conversation.md): 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. Required scope: `conversations:write` - [Search conversations](https://dev.frontapp.com/reference/search-conversations.md): 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. Required scope: `conversations:read` - [Get conversation](https://dev.frontapp.com/reference/get-conversation-by-id.md): Fetch a conversation. Required scope: `conversations:read` - [Update conversation](https://dev.frontapp.com/reference/update-conversation.md): Update a conversation. Required scope: `conversations:write` - [Update conversation assignee](https://dev.frontapp.com/reference/update-conversation-assignee.md): Assign or unassign a conversation. Required scope: `conversations:write` - [List conversation events](https://dev.frontapp.com/reference/list-conversation-events.md): 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. Required scope: `events:*:read` - [List conversation followers](https://dev.frontapp.com/reference/list-conversation-followers.md): List the teammates following a conversation. Required scope: `teammates:read` - [Add conversation followers](https://dev.frontapp.com/reference/add-conversation-followers.md): Adds teammates to the list of followers of a conversation. Required scope: `conversations:write` - [Delete conversation followers](https://dev.frontapp.com/reference/delete-conversation-followers.md): Removes teammates from the list of followers of a conversation. Required scope: `conversations:write` - [List conversation inboxes](https://dev.frontapp.com/reference/list-conversation-inboxes.md): List the inboxes in which a conversation is listed. Required scope: `inboxes:read` - [Add conversation link](https://dev.frontapp.com/reference/add-conversation-link.md): Adds one or more links to a conversation For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic. Required scope: `conversations:write` - [Remove conversation links](https://dev.frontapp.com/reference/remove-conversation-links.md): Removes one or more links to a conversation. For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic. Required scope: `conversations:write` - [List conversation messages](https://dev.frontapp.com/reference/list-conversation-messages.md): List the messages in a conversation in reverse chronological order (newest first). Required scope: `messages:read` - [Update conversation reminders](https://dev.frontapp.com/reference/update-conversation-reminders.md): 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. Required scope: `conversations:write` - [Add conversation tag](https://dev.frontapp.com/reference/add-conversation-tag.md): Adds one or more tags to a conversation Required scope: `conversations:write` - [Remove conversation tag](https://dev.frontapp.com/reference/remove-conversation-tag.md): Removes one or more tags to a conversation Required scope: `conversations:write` - [Delete conversation](https://dev.frontapp.com/reference/delete-conversation.md): Permanently delete a conversation. The conversation must have status "trashed" (in the trash) before it can be permanently deleted. This action cannot be undone. Required scope: `conversations:delete` - [Events](https://dev.frontapp.com/reference/events.md) - [List events](https://dev.frontapp.com/reference/list-events.md): 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. Required scope: `events:*:read` - [Get event](https://dev.frontapp.com/reference/get-event.md): Fetch an event. Refer to the [Events](https://dev.frontapp.com/reference/events) topic for more information, including sorting and filtering. Required scope: `events:*:read` - [Inboxes](https://dev.frontapp.com/reference/inboxes.md) - [List inboxes](https://dev.frontapp.com/reference/list-inboxes.md): List the inboxes of the company. Required scope: `inboxes:read` - [Create inbox](https://dev.frontapp.com/reference/create-inbox.md): 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. Required scope: `inboxes:write` - [Get inbox](https://dev.frontapp.com/reference/get-inbox.md): Fetch an inbox. Required scope: `inboxes:read` - [List inbox channels](https://dev.frontapp.com/reference/list-inbox-channels.md): List the channels in an inbox. Required scope: `channels:read` - [List inbox conversations](https://dev.frontapp.com/reference/list-inbox-conversations.md): List the conversations in an inbox. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations). Required scope: `conversations:read` - [List inbox access](https://dev.frontapp.com/reference/list-inbox-access.md): List the teammates with access to an inbox. Required scope: `teammates:read` - [Add inbox access](https://dev.frontapp.com/reference/add-inbox-access.md): Give access to one or more teammates to an inbox. Required scope: `inboxes:write` - [Removes inbox access](https://dev.frontapp.com/reference/removes-inbox-access.md): Remove access of one or more teammates from an inbox. Required scope: `inboxes:write` - [List team inboxes](https://dev.frontapp.com/reference/list-team-inboxes.md): List the inboxes belonging to a team (workspace). Required scope: `inboxes:read` - [Create team inbox](https://dev.frontapp.com/reference/create-team-inbox.md): Create an inbox for a team (workspace). Required scope: `inboxes:write` - [List teammate private inboxes](https://dev.frontapp.com/reference/list-teammate-private-inboxes.md): List the private inboxes of a teammate. Required scope: `inboxes:read` - [Create teammate private inbox](https://dev.frontapp.com/reference/create-teammate-private-inbox.md): Create a private inbox for a teammate. Required scope: `inboxes:write` - [Knowledge Bases](https://dev.frontapp.com/reference/knowledge-bases.md) - [List knowledge bases](https://dev.frontapp.com/reference/list-knowledge-bases.md): List the knowledge bases of the company. Required scope: `knowledge_bases:read` - [Create a knowledge base](https://dev.frontapp.com/reference/create-a-knowledge-base.md): Creates a knowledge base. Required scope: `knowledge_bases:write` - [Get a knowledge base](https://dev.frontapp.com/reference/get-a-knowledge-base.md): Fetches a knowledge base. Required scope: `knowledge_bases:read` - [Get a knowledge base with content in default locale](https://dev.frontapp.com/reference/get-a-knowledge-base-with-content-in-default-locale.md): Fetches a knowledge base with its content in the default locale. Required scope: `knowledge_bases:read` - [List categories in a knowledge base](https://dev.frontapp.com/reference/list-categories-in-a-knowledge-base.md): List categories in a knowledge base. Required scope: `knowledge_bases:read` - [Update knowledge base in default locale](https://dev.frontapp.com/reference/update-knowledge-base-in-default-locale.md): Updates a knowledge base in the default locale. Will republish the knowledge base if the knowledge base is currently published. Required scope: `knowledge_bases:write` - [List articles in a knowledge base](https://dev.frontapp.com/reference/list-articles-in-a-knowledge-base.md): List articles in a knowledge base Required scope: `knowledge_bases:read` - [Get a knowledge base with content in specified locale](https://dev.frontapp.com/reference/get-a-knowledge-base-with-content-in-specified-locale.md): Fetches a knowledge base with its content for a given locale. Required scope: `knowledge_bases:read` - [Update knowledge base in specified locale](https://dev.frontapp.com/reference/update-knowledge-base-in-specified-locale.md): Updates a knowledge base for a given locale. Will republish the knowledge base if the knowledge base is currently published. Required scope: `knowledge_bases:write` - [Get a knowledge base article](https://dev.frontapp.com/reference/get-a-knowledge-base-article.md): Fetches a knowledge base article. Required scope: `knowledge_bases:read` - [Delete an article](https://dev.frontapp.com/reference/delete-an-article.md): Deletes an article and all its content and translations. Required scope: `knowledge_bases:delete` - [Get knowledge base article with content in default locale](https://dev.frontapp.com/reference/get-knowledge-base-article-with-content-in-default-locale.md): Fetches a knowledge base article with content in the default locale. Required scope: `knowledge_bases:read` - [Update article content in default locale.](https://dev.frontapp.com/reference/update-article-content-in-default-locale.md): Updates an article's content in the default locale Required scope: `knowledge_bases:write` - [Create article in a knowledge base in default locale](https://dev.frontapp.com/reference/create-article-in-a-knowledge-base-in-default-locale.md): Creates an article in a knowledge base in the default locale. Required scope: `knowledge_bases:write` - [Download attachment from an article](https://dev.frontapp.com/reference/download-attachment-from-an-article.md): Downloads the attachment from an article. Required scope: `knowledge_bases:read` - [Get knowledge base article with content in specified locale](https://dev.frontapp.com/reference/get-knowledge-base-article-with-content-in-specified-locale.md): Fetches a knowledge base article with content for a given locale. Required scope: `knowledge_bases:read` - [Update article content in specified locale](https://dev.frontapp.com/reference/update-article-content-in-specified-locale.md): Updates an article's content for a given locale. Required scope: `knowledge_bases:write` - [Create article in a knowledge base in specified locale](https://dev.frontapp.com/reference/create-article-in-a-knowledge-base-in-specified-locale.md): Create an article for a given locale in a knowledge base. Required scope: `knowledge_bases:write` - [Get a knowledge base category](https://dev.frontapp.com/reference/get-a-knowledge-base-category.md): Fetches a knowledge base category. Required scope: `knowledge_bases:read` - [Delete a knowledge base category](https://dev.frontapp.com/reference/delete-a-knowledge-base-category.md): Deletes a knowledge base category. > ⚠️ Warning > > When a category is deleted, all articles in the category are also deleted. Required scope: `knowledge_bases:delete` - [Get knowledge base category content in default locale](https://dev.frontapp.com/reference/get-knowledge-base-category-content-in-default-locale.md): Fetches a knowledge base category with content in the default locale. Required scope: `knowledge_bases:read` - [Update knowledge base category in default locale](https://dev.frontapp.com/reference/update-knowledge-base-category-in-default-locale.md): Updates a knowledge base category in the default locale. Will republish the knowledge base if the knowledge base is currently published. Required scope: `knowledge_bases:write` - [Get knowledge base category with content in specified locale](https://dev.frontapp.com/reference/get-knowledge-base-category-with-content-in-specified-locale.md): Fetches a knowledge base category with content for a given locale. Required scope: `knowledge_bases:read` - [Create knowledge base category in default locale](https://dev.frontapp.com/reference/create-knowledge-base-category-in-default-locale.md): Creates a knowledge base category in the default locale. Required scope: `knowledge_bases:write` - [Update knowledge base category in specified locale](https://dev.frontapp.com/reference/update-knowledge-base-category-in-specified-locale.md): Updates a knowledge base category for a given locale. Will republish the knowledge base if the knowledge base is currently published. Required scope: `knowledge_bases:write` - [List articles in a category](https://dev.frontapp.com/reference/list-articles-in-a-category.md): List articles in a category. Required scope: `knowledge_bases:read` - [Create knowledge base category in specified locale](https://dev.frontapp.com/reference/create-knowledge-base-category-in-specified-locale.md): Creates a knowledge base category for a given locale. Required scope: `knowledge_bases:write` - [Links](https://dev.frontapp.com/reference/links.md) - [List links](https://dev.frontapp.com/reference/list-links.md): List the links of the company paginated by id. Allows filtering by link type via the q.types param. These links include application objects; for more details, see the [Links](https://dev.frontapp.com/reference/links) topic. Required scope: `links:read` - [Create link](https://dev.frontapp.com/reference/create-link.md): Create a link. You must supply either `pattern` or `external_url` in the request, but not both (`pattern` is for application objects while `external_url` is for standard links). If `pattern` is provided, the API call updates the application objects matching the exact pattern. Keep in mind this endpoint only creates or updates an existing link from an application object. It does not create new application objects. If the link is resolved to an installed links integration, any name retrieved from the integration will override the provided name in the request. Required scope: `links:write` - [Get link](https://dev.frontapp.com/reference/get-link.md): Fetch a link. For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic. Required scope: `links:read` - [Update a link](https://dev.frontapp.com/reference/update-a-link.md): Update a link. For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic. Required scope: `links:write` - [List link conversations](https://dev.frontapp.com/reference/list-link-conversations.md): 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. Required scope: `conversations:read` - [API Token details](https://dev.frontapp.com/reference/api-token-details.md): Fetch the details of the API token. - [List folders](https://dev.frontapp.com/reference/list-folders.md): List the message template folders. Required scope: `message_templates:read` - [Create folder](https://dev.frontapp.com/reference/create-folder.md): Create a new message template folder in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team folder](https://dev.frontapp.com/reference/create-team-folder) endpoint instead. Required scope: `message_templates:write` - [Get folder](https://dev.frontapp.com/reference/get-folder.md): Fetch a message template folder. Required scope: `message_templates:read` - [Update folder](https://dev.frontapp.com/reference/update-folder.md): Update message template folder Required scope: `message_templates:write` - [Delete folder](https://dev.frontapp.com/reference/delete-folder.md): Delete a message template folder and child folders/templates Required scope: `message_templates:delete` - [Get child folders](https://dev.frontapp.com/reference/get-child-folders.md): Fetch the child message templates folders of a message template folder. Required scope: `message_templates:read` - [Create child folder](https://dev.frontapp.com/reference/create-child-folder.md): Create a new message template folder as a child of the given folder Required scope: `message_templates:write` - [List teammate folders](https://dev.frontapp.com/reference/list-teammate-folders.md): List the message template folders belonging to the requested teammate. Required scope: `message_templates:read` - [Create teammate folder](https://dev.frontapp.com/reference/create-teammate-folder.md): Create a new message template folder belonging to the requested teammate. Required scope: `message_templates:write` - [List team folders](https://dev.frontapp.com/reference/list-team-folders.md): List the message template folders belonging to the requested team (workspace). Required scope: `message_templates:read` - [Create team folder](https://dev.frontapp.com/reference/create-team-folder.md): Create a new message template folder belonging to the requested team (workspace). Required scope: `message_templates:write` - [Message Templates](https://dev.frontapp.com/reference/message-templates.md) - [Get child templates](https://dev.frontapp.com/reference/get-child-templates.md): Fetch the child message templates of a message template folder. Required scope: `message_templates:read` - [Create child template](https://dev.frontapp.com/reference/create-child-template.md): Create a new message template as a child of the given folder Required scope: `message_templates:write` - [List message templates](https://dev.frontapp.com/reference/list-message-templates.md): List the message templates. Required scope: `message_templates:read` - [Create message template](https://dev.frontapp.com/reference/create-message-template.md): Create a new message template in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team message template](https://dev.frontapp.com/reference/create-team-message-template) endpoint instead. Required scope: `message_templates:write` - [Get message template](https://dev.frontapp.com/reference/get-message-template.md): Fetch a message template. Required scope: `message_templates:read` - [Update message template](https://dev.frontapp.com/reference/update-message-template.md): Update a message template. Required scope: `message_templates:write` - [Delete message template](https://dev.frontapp.com/reference/delete-message-template.md): Delete a message template Required scope: `message_templates:delete` - [List teammate message templates](https://dev.frontapp.com/reference/list-teammate-message-templates.md): List the message templates belonging to the requested teammate. Required scope: `message_templates:read` - [Create teammate message template](https://dev.frontapp.com/reference/create-teammate-message-template.md): Create a new message template for the given teammate Required scope: `message_templates:write` - [List team message templates](https://dev.frontapp.com/reference/list-team-message-templates.md): List the message templates belonging to the requested team (workspace). Required scope: `message_templates:read` - [Create team message template](https://dev.frontapp.com/reference/create-team-message-template.md): Create a new message template for the given team (workspace). Required scope: `message_templates:write` - [Shifts](https://dev.frontapp.com/reference/shifts.md) - [Get shift](https://dev.frontapp.com/reference/get-shift.md): Fetch a shift. Required scope: `shifts:read` - [List shift's teammates](https://dev.frontapp.com/reference/list-shifts-teammates.md): List the teammates assigned to a shift. Required scope: `teammates:read` - [Add teammates to shift](https://dev.frontapp.com/reference/add-teammates-to-shift.md): Add teammates to a shift. The selected teammates must be in the team that owns the shift. Required scope: `shifts:write` - [Remove teammates from shift](https://dev.frontapp.com/reference/remove-teammates-from-shift.md): Remove teammates from a shift. Required scope: `shifts:write` - [List Shifts](https://dev.frontapp.com/reference/list-shifts.md): List the shifts. Required scope: `shifts:read` - [Create shift](https://dev.frontapp.com/reference/create-shift.md): Create a shift in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team shift](https://dev.frontapp.com/reference/create-team-shift) endpoint instead. Required scope: `shifts:write` - [Update shift](https://dev.frontapp.com/reference/update-shift.md): Update a shift. Required scope: `shifts:write` - [List Teammate Shifts](https://dev.frontapp.com/reference/list-teammate-shifts.md): Lists all the shifts for the teammate. Required scope: `shifts:read` - [List team Shifts](https://dev.frontapp.com/reference/list-team-shifts.md): List the shifts for a team (workspace). Required scope: `shifts:read` - [Create team shift](https://dev.frontapp.com/reference/create-team-shift.md): Create a shift for a team (workspace). Required scope: `shifts:write` - [Get signatures](https://dev.frontapp.com/reference/get-signatures.md): Get the given signature. Required scope: `signatures:read` - [Update signature](https://dev.frontapp.com/reference/update-signature.md): Update signature Required scope: `signatures:write` - [Delete signature](https://dev.frontapp.com/reference/delete-signature.md): Delete signature Required scope: `signatures:delete` - [List teammate signatures](https://dev.frontapp.com/reference/list-teammate-signatures.md): List the signatures belonging to the given teammate. Required scope: `signatures:read` - [Create teammate signature](https://dev.frontapp.com/reference/create-teammate-signature.md): Create a new signature for the given teammate Required scope: `signatures:write` - [List team signatures](https://dev.frontapp.com/reference/list-team-signatures.md): List the signatures belonging to the given team (workspace). Required scope: `signatures:read` - [Create team signature](https://dev.frontapp.com/reference/create-team-signature.md): Create a new signature for the given team (workspace). Required scope: `signatures:write` - [Teammate groups](https://dev.frontapp.com/reference/teammate-groups.md) - [List teammate groups](https://dev.frontapp.com/reference/list-company-teammate-groups.md): List the teammate groups in the company. Required scope: `teammate_groups:read` - [Create teammate group](https://dev.frontapp.com/reference/create-company-teammate-group.md): Create a new teammate group. Required scope: `teammate_groups:write` - [Get teammate group](https://dev.frontapp.com/reference/get-company-teammate-group.md): Fetch a teammate group. Required scope: `teammate_groups:read` - [Update a teammate group](https://dev.frontapp.com/reference/update-a-company-teammate-group.md): Updates a teammate group. Note - You cannot modify a teammate group that is managed by SCIM. Required scope: `teammate_groups:write` - [Delete teammate group](https://dev.frontapp.com/reference/delete-company-teammate-group.md): Deletes a teammate group. Note - You cannot delete a teammate group that is managed by SCIM. Required scope: `teammate_groups:delete` - [List teammate group team inboxes](https://dev.frontapp.com/reference/list-company-teammate-group-team-inboxes.md): List inboxes that the teammate group has access to via its associated teams. Required scope: `inboxes:read` - [Add teammate group team inboxes](https://dev.frontapp.com/reference/add-company-teammate-group-team-inboxes.md): Links non-public inboxes to the teammate group. The inbox must be part of a team that has been added to the teammate group. Required scope: `teammate_groups:write` - [Remove teammate group team inboxes](https://dev.frontapp.com/reference/remove-company-teammate-group-team-inboxes.md): Unlinks non-public inboxes from the teammate group. Required scope: `teammate_groups:write` - [List teammate group teammates](https://dev.frontapp.com/reference/list-company-teammate-group-teammates.md): List teammate group teammates. Required scope: `teammates:read` - [Add teammate group teammates](https://dev.frontapp.com/reference/add-company-teammate-group-teammates.md): Add teammate group teammates. Note - You cannot modify a teammate group that is managed by SCIM. Required scope: `teammate_groups:write` - [Remove teammate group teammates](https://dev.frontapp.com/reference/remove-company-teammate-group-teammates.md): Remove teammate group teammates. Note - You cannot modify a teammate group that is managed by SCIM. Required scope: `teammate_groups:write` - [List teammate group teams](https://dev.frontapp.com/reference/list-company-teammate-group-teams.md): List teams added to the teammate group. Any teams added to the teammate group will automatically link public inboxes. Required scope: `teams:read` - [Add teammate group teams](https://dev.frontapp.com/reference/add-company-teammate-group-teams.md): Adds teams to the teammate group. Any teams added to the teammate group will automatically link public inboxes. Non-public inboxes can be added to the teammate group separately. Required scope: `teammate_groups:write` - [Remove teammate group teams](https://dev.frontapp.com/reference/remove-company-teammate-group-teams.md): Remove teams from the teammate group. Unlinks to any associated team inboxes. Required scope: `teammate_groups:write` - [Teammates](https://dev.frontapp.com/reference/teammates.md) - [List teammates](https://dev.frontapp.com/reference/list-teammates.md): List the teammates in the company. Required scope: `teammates:read` - [Get teammate](https://dev.frontapp.com/reference/get-teammate.md): Fetch a teammate. Required scope: `teammates:read` - [Update teammate](https://dev.frontapp.com/reference/update-teammate.md): Update a teammate. Required scope: `teammates:write` - [List assigned conversations](https://dev.frontapp.com/reference/list-assigned-conversations.md): List the conversations assigned to a teammate in reverse chronological order (most recently updated first). For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations). Required scope: `conversations:read` - [List teammate inboxes](https://dev.frontapp.com/reference/list-teammate-inboxes.md): Returns list of inboxes the teammate has access to. Required scope: `inboxes:read` - [Time Off](https://dev.frontapp.com/reference/time-off.md) - [Get time off](https://dev.frontapp.com/reference/get-time-off.md): Fetch a time off. Required scope: `time_off:read` - [List teammate time offs](https://dev.frontapp.com/reference/list-teammate-time-offs.md): List the time offs of a teammate. Required scope: `time_off:read` - [List team time offs](https://dev.frontapp.com/reference/list-team-time-offs.md): List the time offs of all teammates in a team. Required scope: `time_off:read` - [Create time off](https://dev.frontapp.com/reference/create-time-off.md): Create a time off for a teammate. Required scope: `time_off:write` - [Update time off](https://dev.frontapp.com/reference/update-time-off.md): Update a time off. Required scope: `time_off:write` - [Delete time off](https://dev.frontapp.com/reference/delete-time-off.md): Delete a time off. Required scope: `time_off:delete` - [Teams / Workspaces](https://dev.frontapp.com/reference/teams.md) - [List teams](https://dev.frontapp.com/reference/list-teams.md): List the teams (workspaces) in the company. Required scope: `teams:read` - [Get team](https://dev.frontapp.com/reference/get-team.md): Fetch a team (workspace). Required scope: `teams:read` - [Add teammates to team](https://dev.frontapp.com/reference/add-teammates-to-team.md): Add one or more teammates to a team (workspace). Required scope: `teams:write` - [Remove teammates from team](https://dev.frontapp.com/reference/remove-teammates-from-team.md): Remove one or more teammates from a team (workspace). Required scope: `teams:write` - [Views](https://dev.frontapp.com/reference/views.md) - [List team views](https://dev.frontapp.com/reference/list-team-views.md): List the views of a team. Required scope: `views:read` - [Create team view](https://dev.frontapp.com/reference/create-team-view.md): Create a new view for a team. Required scope: `views:write` - [List views](https://dev.frontapp.com/reference/list-views.md): List the views accessible to the authenticated token. Required scope: `views:read` - [Get view](https://dev.frontapp.com/reference/get-view.md): Fetch a view. Required scope: `views:read` - [Update view](https://dev.frontapp.com/reference/update-view.md): Update a view. Required scope: `views:write` - [Add view to teammate sidebars](https://dev.frontapp.com/reference/add-view-teammates.md): Makes this view visible in specified teammates' sidebar navigation. Required scope: `views:write` - [Installation](https://dev.frontapp.com/reference/installation.md) - [Plugin Terminology 101](https://dev.frontapp.com/reference/plugin-terminology-101.md) - [Getting events from Front](https://dev.frontapp.com/reference/event-observables.md) - [Front.contextUpdates](https://dev.frontapp.com/reference/context-updates.md): Observable for changes of context. - [Context API](https://dev.frontapp.com/reference/plugin-sdk-api.md) - [addLink](https://dev.frontapp.com/reference/addlink.md) - [addTopic](https://dev.frontapp.com/reference/addtopic.md): Add a topic to the selected conversations. - [assign](https://dev.frontapp.com/reference/assign.md): Assign or unassign the selected conversations. - [close](https://dev.frontapp.com/reference/close.md): Closes the composer plugin window. - [closeDraft](https://dev.frontapp.com/reference/closedraft.md): Closes an open plugin window and the associated draft composer - [createDraft](https://dev.frontapp.com/reference/createdraft.md): Open a composer with a new draft message. - [dismissNotification](https://dev.frontapp.com/reference/dismissnotification.md): Close a voice call notification - [displayNotification](https://dev.frontapp.com/reference/displaynotification.md): Display a voice call notification to the Front teammate - [downloadAttachment](https://dev.frontapp.com/reference/downloadattachment.md): Since [Attachments](ref:plugin-sdk-attachment) that are returned as part of the [Message](ref:plugin-sdk-message) or [Comment](ref:comment) contain only metadata about the attachment, this method enables the downloading of the content of that attachment. - [downloadComposerAttachment](https://dev.frontapp.com/reference/addlink-copy.md): Since [Attachments](ref:plugin-sdk-attachment) that are returned as part of the [draft](ref:plugin-sdk-draft), this method enables the downloading of the content of that attachment. - [fetchDraft](https://dev.frontapp.com/reference/fetchdraft.md): Fetch a draft message. - [fetchPath](https://dev.frontapp.com/reference/fetchpath.md): Returns the user's current location within the application. Only supports paths that are located within the `/inboxes` route. - [listChannels](https://dev.frontapp.com/reference/listchannels.md): Lists the channels accessible by the current teammate. - [listComments](https://dev.frontapp.com/reference/listcomments.md): List the comments in the current conversation. - [listInboxes](https://dev.frontapp.com/reference/listinboxes.md): Lists the inboxes accessible by the current teammate. - [listMessages](https://dev.frontapp.com/reference/listmessages.md): List the messages in the current conversation. Note that the plugin context will only have access to messages that have loaded for the user. For different reasons, some messages within a conversation will not have loaded for a user, meaning that this function will return undefined for those messages. If you need to definitively load all messages for a conversation, use the [Core API](https://dev.frontapp.com/reference/get_conversations-conversation-id-messages). - [listRecipients](https://dev.frontapp.com/reference/listrecipients.md): List the recipients in the current conversation in the order in which the messages are sent. - [listTags](https://dev.frontapp.com/reference/listtags.md): Lists the tags accessible to the current teammate. - [listTeammates](https://dev.frontapp.com/reference/listteammates.md): Lists the teammates in the company. - [listTicketStatuses](https://dev.frontapp.com/reference/listticketstatuses.md): List the ticket statuses available for the company. - [move](https://dev.frontapp.com/reference/move.md): Move the selected conversations to an inbox. - [openConversationInPopup](https://dev.frontapp.com/reference/openconversationinpopup.md): Requests Front to open a conversation in a popup. - [openUrl](https://dev.frontapp.com/reference/openurl.md): Requests Front to open a URL - [openUrlInPopup](https://dev.frontapp.com/reference/openurlinpopup.md): Requests Front to open a URL in a popup - [removeLink](https://dev.frontapp.com/reference/removelink.md) - [search](https://dev.frontapp.com/reference/search.md): Perform a search in Front. - [setStatus](https://dev.frontapp.com/reference/setstatus.md): Set the status of the selected conversations. - [tag](https://dev.frontapp.com/reference/tag.md): Add tags to the selected conversations. - [untag](https://dev.frontapp.com/reference/untag.md): Remove tags from the selected conversations. - [updateDraft](https://dev.frontapp.com/reference/updatedraft.md): Update a draft message. - [buildCancelTokenSource](https://dev.frontapp.com/reference/buildcanceltokensource.md): Build an object to be used to cancel context API call. - [isCancelError](https://dev.frontapp.com/reference/iscancelerror.md): Check if an error is a cancel error - [delegateAnchorClicksToFront](https://dev.frontapp.com/reference/delegateanchorclickstofront.md): Listen for clicks on links and programatic window opens to automatically decide whether to open them via Front - [delegateNewWindowsToFront](https://dev.frontapp.com/reference/delegatenewwindowstofront.md) - [Data models](https://dev.frontapp.com/reference/plugin-sdk-objects.md) - [Attachment](https://dev.frontapp.com/reference/plugin-sdk-attachment.md): An attachment is a file attached to a message or a comment. - [CancelToken](https://dev.frontapp.com/reference/plugin-sdk-cancel-token.md): Token to make the invocation of a function cancellable. - [Channel](https://dev.frontapp.com/reference/plugin-sdk-channel.md): A channel is a used to send and receive messages. - [Comment](https://dev.frontapp.com/reference/comment.md) - [Contact](https://dev.frontapp.com/reference/plugin-sdk-contact.md): A contact is a record in Front Contact Manager. - [Context](https://dev.frontapp.com/reference/plugin-sdk-context.md): A context represents a partial state of Front that the user is interacting with. - [EntryPoint](https://dev.frontapp.com/reference/entrypoint.md): Represents data about the entry point that opened a plugin. Available from the [Context](ref:plugin-sdk-context) object. - [Conversation](https://dev.frontapp.com/reference/plugin-sdk-conversation.md): A conversation is a unique thread of messages and comments. - [CustomField](https://dev.frontapp.com/reference/customfield.md): Extra fields that can be custom specified by customers to augment original Front resources such as conversations or contacts. - [Draft message](https://dev.frontapp.com/reference/plugin-sdk-draft.md): A draft is a message that has not been sent yet. - [Inbox](https://dev.frontapp.com/reference/plugn-sdk-inbox.md): An inbox is a container for conversations. - [Link](https://dev.frontapp.com/reference/link.md): A link is a specific kind of tag that links to an external URL. - [Message](https://dev.frontapp.com/reference/plugin-sdk-message.md) - [PaginationToken](https://dev.frontapp.com/reference/plugin-sdk-pagination-token.md) - [Recipient](https://dev.frontapp.com/reference/plugin-sdk-recipient.md) - [Tag](https://dev.frontapp.com/reference/plugin-sdk-tag.md): A tag is a resource used to organize and classify conversations. - [Teammate](https://dev.frontapp.com/reference/plugin-sdk-teammate.md): A teammate is a Front user. - [TicketStatus](https://dev.frontapp.com/reference/ticketstatus.md): A ticket status availabe for the company. - [Topic](https://dev.frontapp.com/reference/plugin-sdk-topic.md): A topic is a specific kind of tag that links to an external URL. - [Introduction](https://dev.frontapp.com/reference/introduction-1.md) - [API endpoints](https://dev.frontapp.com/reference/channel-api.md) - [Sync inbound message](https://dev.frontapp.com/reference/sync-inbound-message.md): Import a message that was received by the channel. - [Sync outbound message](https://dev.frontapp.com/reference/sync-outbound-message.md): Import a message that was sent from the channel. - [Update Channel](https://dev.frontapp.com/reference/update-channel-1.md): Update a channel. - [Update external message status](https://dev.frontapp.com/reference/update-external-message-status.md): Update the status of an outbound message by external ID. This endpoint is used by external systems (like SMS providers or custom channels) to notify Front when a message's delivery status has changed. **Available status changes:** - `failed`: Mark a message as failed. When marked as failed, the conversation is reopened so the team can take action. **Note:** This endpoint is only available for outbound messages. - [Message templates](https://dev.frontapp.com/reference/message-templates-1.md) - [Sync application message template](https://dev.frontapp.com/reference/sync-application-message-template.md): Import an application message template from an external service (such as WhatsApp or Facebook). The message template becomes available for use by the channel specified if configured as described in [this topic](https://dev.frontapp.com/update/docs/application-channel-message-templates). - [Update application message template](https://dev.frontapp.com/reference/update-application-message-template.md): Update an application message template that already exists in Front. - [Voice calls](https://dev.frontapp.com/reference/voice-calls.md) - [Create a call](https://dev.frontapp.com/reference/create-call.md): Creates a call in Front. - [Add call transcript](https://dev.frontapp.com/reference/add-call-transcript.md): Adds a transcript to a call in Front. - [Add call summary](https://dev.frontapp.com/reference/add-call-summary.md): Adds a summary to a call in Front. - [Add call recording](https://dev.frontapp.com/reference/add-call-recording.md): Adds a recording to a call in Front. Send `multipart/form-data` with exactly one file in the `attachments` field, `Content-Type: audio/*`, and required `recording_type` (`call` or `voicemail`). - [Update call status](https://dev.frontapp.com/reference/update-call.md): Updates the call status of a call in Front.