Front integration: operations for AI agents
Front connects to Type.com as an integration. This page lists the 246 operations documented for Claude and Codex in Type.com: 124 read, 93 write, 29 destructive.
About Front
Front is a shared inbox and customer communication platform for email, SMS, and chat, with conversations, contacts, tags, and analytics.
Categories: Customer Support
How to connect Front to Type.com
- Connect
- Managed OAuth through Pipedream when enabled for your workspace
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
246 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
246 operations listed.
Comments
- Read
Get comment
Fetches a comment. Required scope: comments:read
GET /comments/{comment_id} - Read
List comment mentions
List the teammates mentioned in a comment. Required scope: teammates:read
GET /comments/{comment_id}/mentions - Read
List conversation comments
List the comments in a conversation in reverse chronological order (newest first). Required scope: comments:read
GET /conversations/{conversation_id}/comments - Write
Add comment
Add a comment to a conversation. If you want to create a new comment-only conversation, use the Create discussion conversation endpoint. Required scope: comments:write
POST /conversations/{conversation_id}/comments - Write
Add comment reply
Add a reply to a comment on a conversation. Comment replies visually indicate which comment is being responded to, helping users follow the conversation. Required scope: comments:write
POST /comments/{comment_id}/replies - Write
Update comment
Update a comment in a conversation. Required scope: comments:write
PATCH /comments/{comment_id}
Teammate groups
- Read
Get teammate group
Fetch a teammate group. Required scope: teammategroups:read
GET /teammate_groups/{teammate_group_id} - Read
List teammate group team inboxes
List inboxes that the teammate group has access to via its associated teams. Required scope: inboxes:read
GET /teammate_groups/{teammate_group_id}/inboxes - Read
List teammate group teammates
List teammate group teammates. Required scope: teammates:read
GET /teammate_groups/{teammate_group_id}/teammates - Read
List teammate group teams
List teams added to the teammate group. Any teams added to the teammate group will automatically link public inboxes. Required scope: teams:read
GET /teammate_groups/{teammate_group_id}/teams - Read
List teammate groups
List the teammate groups in the company. Required scope: teammategroups:read
GET /teammate_groups - Write
Add teammate group team inboxes
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: teammategroups:write
POST /teammate_groups/{teammate_group_id}/inboxes - Write
Add teammate group teammates
Add teammate group teammates. Note - You cannot modify a teammate group that is managed by SCIM. Required scope: teammategroups:write
POST /teammate_groups/{teammate_group_id}/teammates - Write
Add teammate group teams
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: teammategroups:write
POST /teammate_groups/{teammate_group_id}/teams - Write
Create teammate group
Create a new teammate group. Required scope: teammategroups:write
POST /teammate_groups - Write
Update a teammate group
Updates a teammate group. Note - You cannot modify a teammate group that is managed by SCIM. Required scope: teammategroups:write
PATCH /teammate_groups/{teammate_group_id} - Destructive
Delete teammate group
Deletes a teammate group. Note - You cannot delete a teammate group that is managed by SCIM. Required scope: teammategroups:delete
DELETE /teammate_groups/{teammate_group_id} - Destructive
Remove teammate group team inboxes
Unlinks non-public inboxes from the teammate group. Required scope: teammategroups:write
DELETE /teammate_groups/{teammate_group_id}/inboxes - Destructive
Remove teammate group teammates
Remove teammate group teammates. Note - You cannot modify a teammate group that is managed by SCIM. Required scope: teammategroups:write
DELETE /teammate_groups/{teammate_group_id}/teammates - Destructive
Remove teammate group teams
Remove teams from the teammate group. Unlinks to any associated team inboxes. Required scope: teammategroups:write
DELETE /teammate_groups/{teammate_group_id}/teams
Contact Handles
- Write
Add contact handle
Adds a new handle to a contact. Required scope: contacts:write
POST /contacts/{contact_id}/handles - Destructive
Delete contact handle
Remove a handle from a contact. Required scope: contacts:write
DELETE /contacts/{contact_id}/handles
Accounts
- Read
Fetch an account
Fetches an account Required scope: accounts:read
GET /accounts/{account_id} - Read
List account contacts
Lists the contacts associated with an Account Required scope: contacts:read
GET /accounts/{account_id}/contacts - Read
List Accounts
List the accounts of the company. Required scope: accounts:read
GET /accounts - Write
Add contact to Account
Adds a list of contacts to an Account Required scope: accounts:write
POST /accounts/{account_id}/contacts - Write
Create account
Create a new account. Required scope: accounts:write
POST /accounts - Write
Update account
Updates an account. Required scope: accounts:write
PATCH /accounts/{account_id} - Destructive
Delete an account
Deletes an account Required scope: accounts:delete
DELETE /accounts/{account_id} - Destructive
Remove contact from Account
Removes a list of contacts from an Account Required scope: accounts:write
DELETE /accounts/{account_id}/contacts
Contact Lists
- Read
List contact lists
List contact lists. Required scope: contacts:read
GET /contact_lists - Read
List contacts in contact list
List the contacts belonging to the requested contact list. Required scope: contacts:read
GET /contact_lists/{contact_list_id}/contacts - Read
List team contact lists
List contact lists belonging to the requested team (workspace). Required scope: contacts:read
GET /teams/{team_id}/contact_lists - Read
List teammate contact lists
List the contact lists belonging to the requested teammate. Required scope: contacts:read
GET /teammates/{teammate_id}/contact_lists - Write
Add contacts to contact list
Add contacts to the requested contact list. Required scope: contacts:write
POST /contact_lists/{contact_list_id}/contacts - Write
Create contact list
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 endpoint instead. Required scope: contacts:write
POST /contact_lists - Write
Create team contact list
Create a new contact list for the requested team (workspace). Required scope: contacts:write
POST /teams/{team_id}/contact_lists - Write
Create teammate contact list
Create a new contact list for the requested teammate. Required scope: contacts:write
POST /teammates/{teammate_id}/contact_lists - Destructive
Delete contact list
Delete a contact lists. Required scope: contacts:delete
DELETE /contact_lists/{contact_list_id} - Destructive
Remove contacts from contact list
Remove contacts from the requested contact list. Required scope: contacts:write
DELETE /contact_lists/{contact_list_id}/contacts
Contact Groups
- Read
List contacts in group (deprecated)
List the contacts belonging to the requested group. ⚠️ Deprecated endpoint This endpoint has been deprecated. Please use the compatible contact list endpoints instead. - GET /contactlists/{contactlistid}/contacts. Required scope: contacts:read
GET /contact_groups/{contact_group_id}/contacts - Read
List groups (deprecated)
List the contact groups. ⚠️ Deprecated endpoint This endpoint has been deprecated. Please use the compatible contact list endpoints instead. - GET /contactlists. Required scope: contacts:read
GET /contact_groups - Read
List team groups (deprecated)
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/{teamid}/contactlists. Required scope: contacts:read
GET /teams/{team_id}/contact_groups - Read
List teammate groups (deprecated)
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/{teammateid}/contactlists. Required scope: contacts:read
GET /teammates/{teammate_id}/contact_groups - Write
Add contacts to group (deprecated)
Add contacts to the requested group. ⚠️ Deprecated endpoint This endpoint has been deprecated. Please use the compatible contact list endpoints instead. - POST /contactlists/{contactlistid}/contacts. Required scope: contacts:write
POST /contact_groups/{contact_group_id}/contacts - Write
Create group (deprecated)
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 /contactlists. Required scope: contacts:write
POST /contact_groups - Write
Create team group (deprecated)
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/{teamid}/contactlists. Required scope: contacts:write
POST /teams/{team_id}/contact_groups - Write
Create teammate group (deprecated)
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/{teammateid}/contactlists. Required scope: contacts:write
POST /teammates/{teammate_id}/contact_groups - Destructive
Delete group (deprecated)
Delete a contact group. ⚠️ Deprecated endpoint This endpoint has been deprecated. Please use the compatible contact list endpoints instead. - DELETE /contactlists/{contactlistid}. Required scope: contacts:delete
DELETE /contact_groups/{contact_group_id} - Destructive
Remove contacts from group
Remove contacts from the requested group. ⚠️ Deprecated endpoint This endpoint has been deprecated. Please use the compatible contact list endpoints instead. - DELETE /contactlists/{contactlistid}/contacts. Required scope: contacts:write
DELETE /contact_groups/{contact_group_id}/contacts
Conversations
- Read
Get conversation
Fetch a conversation. Required scope: conversations:read
GET /conversations/{conversation_id} - Read
List conversation events
List the events that occured for a conversation in reverse chronological order (newest first). The order will respect your company's bump settings, which determine when conversations bump to the top. Required scope: events::read
GET /conversations/{conversation_id}/events - Read
List conversation followers
List the teammates following a conversation. Required scope: teammates:read
GET /conversations/{conversation_id}/followers - Read
List conversation inboxes
List the inboxes in which a conversation is listed. Required scope: inboxes:read
GET /conversations/{conversation_id}/inboxes - Read
List conversation messages
List the messages in a conversation in reverse chronological order (newest first). Required scope: messages:read
GET /conversations/{conversation_id}/messages - Read
List conversations
List the conversations in the company in reverse chronological order (most recently updated first). The order will respect your company's bump settings, which determine when conversations bump to the top. For more advanced filtering, see the search endpoint. Required scope: conversations:read
GET /conversations - Read
List linked conversations
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. Required scope: conversations:read
GET /conversations/{conversation_id}/linked_conversations - Read
Search conversations
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 for usage examples. Note: This endpoint is subject to proportional rate limiting at 40% of your company's rate limit. Required scope: conversations:read
GET /conversations/search/{query} - Write
Add conversation followers
Adds teammates to the list of followers of a conversation. Required scope: conversations:write
POST /conversations/{conversation_id}/followers - Write
Add conversation link
Adds one or more links to a conversation For more information on links, see the Links topic. Required scope: conversations:write
POST /conversations/{conversation_id}/links - Write
Add conversation tag
Adds one or more tags to a conversation Required scope: conversations:write
POST /conversations/{conversation_id}/tags - Write
Create discussion/task conversation
Create 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 endpoint. If you want to add a comment to an existing conversation, use the Add comment endpoint. Required scope: conversations:write
POST /conversations - Write
Link conversations
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. Required scope: conversations:write
POST /conversations/{conversation_id}/linked_conversations - Write
Update conversation
Update a conversation. Required scope: conversations:write
PATCH /conversations/{conversation_id} - Write
Update conversation reminders
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
PATCH /conversations/{conversation_id}/reminders - Destructive
Delete conversation
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
DELETE /conversations/{conversation_id} - Destructive
Delete conversation followers
Removes teammates from the list of followers of a conversation. Required scope: conversations:write
DELETE /conversations/{conversation_id}/followers - Destructive
Remove conversation links
Removes one or more links to a conversation. For more information on links, see the Links topic. Required scope: conversations:write
DELETE /conversations/{conversation_id}/links - Destructive
Remove conversation tag
Removes one or more tags to a conversation Required scope: conversations:write
DELETE /conversations/{conversation_id}/tags - Destructive
Update conversation assignee
Assign or unassign a conversation. Required scope: conversations:write
PUT /conversations/{conversation_id}/assignee
Inboxes
- Read
Get inbox
Fetch an inbox. Required scope: inboxes:read
GET /inboxes/{inbox_id} - Read
List inbox access
List the teammates with access to an inbox. Required scope: teammates:read
GET /inboxes/{inbox_id}/teammates - Read
List inbox channels
List the channels in an inbox. Required scope: channels:read
GET /inboxes/{inbox_id}/channels - Read
List inbox conversations
List the conversations in an inbox. For more advanced filtering, see the search endpoint. Required scope: conversations:read
GET /inboxes/{inbox_id}/conversations - Read
List inboxes
List the inboxes of the company. Required scope: inboxes:read
GET /inboxes - Read
List team inboxes
List the inboxes belonging to a team (workspace). Required scope: inboxes:read
GET /teams/{team_id}/inboxes - Read
List teammate private inboxes
List the private inboxes of a teammate. Required scope: inboxes:read
GET /teammates/{teammate_id}/private_inboxes - Write
Add inbox access
Give access to one or more teammates to an inbox. Required scope: inboxes:write
POST /inboxes/{inbox_id}/teammates - Write
Create inbox
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 endpoint instead. Required scope: inboxes:write
POST /inboxes - Write
Create team inbox
Create an inbox for a team (workspace). Required scope: inboxes:write
POST /teams/{team_id}/inboxes - Write
Create teammate private inbox
Create a private inbox for a teammate. Required scope: inboxes:write
POST /teammates/{teammate_id}/private_inboxes - Destructive
Removes inbox access
Remove access of one or more teammates from an inbox. Required scope: inboxes:write
DELETE /inboxes/{inbox_id}/teammates
Contact Notes
- Read
List notes
List the notes added to a contact. Required scope: contacts:read
GET /contacts/{contact_id}/notes - Write
Add note
Create a new note on a contact. Required scope: contacts:write
POST /contacts/{contact_id}/notes
Shifts
- Read
Get shift
Fetch a shift. Required scope: shifts:read
GET /shifts/{shift_id} - Read
List Shifts
List the shifts. Required scope: shifts:read
GET /shifts - Read
List shift's teammates
List the teammates assigned to a shift. Required scope: teammates:read
GET /shifts/{shift_id}/teammates - Read
List team Shifts
List the shifts for a team (workspace). Required scope: shifts:read
GET /teams/{team_id}/shifts - Read
List Teammate Shifts
Lists all the shifts for the teammate. Required scope: shifts:read
GET /teammates/{teammate_id}/shifts - Write
Add teammates to shift
Add teammates to a shift. The selected teammates must be in the team that owns the shift. Required scope: shifts:write
POST /shifts/{shift_id}/teammates - Write
Create shift
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 endpoint instead. Required scope: shifts:write
POST /shifts - Write
Create team shift
Create a shift for a team (workspace). Required scope: shifts:write
POST /teams/{team_id}/shifts - Write
Update shift
Update a shift. Required scope: shifts:write
PATCH /shifts/{shift_id} - Destructive
Remove teammates from shift
Remove teammates from a shift. Required scope: shifts:write
DELETE /shifts/{shift_id}/teammates
Teams
- Read
Get team
Fetch a team (workspace). Required scope: teams:read
GET /teams/{team_id} - Read
List teams
List the teams (workspaces) in the company. Required scope: teams:read
GET /teams - Write
Add teammates to team
Add one or more teammates to a team (workspace). Required scope: teams:write
POST /teams/{team_id}/teammates - Destructive
Remove teammates from team
Remove one or more teammates from a team (workspace). Required scope: teams:write
DELETE /teams/{team_id}/teammates
Views
- Read
Get view
Fetch a view. Required scope: views:read
GET /views/{view_id} - Read
List team views
List the views of a team. Required scope: views:read
GET /teams/{team_id}/views - Read
List views
List the views accessible to the authenticated token. Required scope: views:read
GET /views - Write
Add view to teammate sidebars
Makes this view visible in specified teammates' sidebar navigation. Required scope: views:write
POST /views/{view_id}/teammates - Write
Create team view
Create a new view for a team. Required scope: views:write
POST /teams/{team_id}/views - Write
Update view
Update a view. Required scope: views:write
PATCH /views/{view_id}
Token Identity
- Read
API Token details
Fetch the details of the API token.
GET /me
Channels
- Read
Get channel
Fetch a channel. Required scope: channels:read
GET /channels/{channel_id} - Read
List channels
List the channels of the company. Required scope: channels:read
GET /channels - Read
List team channels
List the channels of a team (workspace). Required scope: channels:read
GET /teams/{team_id}/channels - Read
List teammate channels
List the channels of a teammate. Required scope: channels:read
GET /teammates/{teammate_id}/channels - Write
Create a channel
Create a channel in an inbox. Required scope: channels:write
POST /inboxes/{inbox_id}/channels - Write
Update Channel
Update a channel. Required scope: channels:write
PATCH /channels/{channel_id} - Write
Validate channel
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 sendas 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
POST /channels/{channel_id}/validate
Knowledge Bases
- Read
Get a knowledge base
Fetches a knowledge base. Required scope: knowledgebases:read
GET /knowledge_bases/{knowledge_base_id} - Read
Get a knowledge base with content in default locale
Fetches a knowledge base with its content in the default locale. Required scope: knowledgebases:read
GET /knowledge_bases/{knowledge_base_id}/content - Read
Get a knowledge base with content in specified locale
Fetches a knowledge base with its content for a given locale. Required scope: knowledgebases:read
GET /knowledge_bases/{knowledge_base_id}/locales/{locale}/content - Read
List knowledge bases
List the knowledge bases of the company. Required scope: knowledgebases:read
GET /knowledge_bases - Write
Create a knowledge base
Creates a knowledge base. Required scope: knowledgebases:write
POST /knowledge_bases - Write
Create article in a knowledge base in default locale
Creates an article in a knowledge base in the default locale. Required scope: knowledgebases:write
POST /knowledge_bases/{knowledge_base_id}/articles - Write
Create article in a knowledge base in specified locale
Create an article for a given locale in a knowledge base. Required scope: knowledgebases:write
POST /knowledge_bases/{knowledge_base_id}/locales/{locale}/articles - Write
Create knowledge base category in default locale
Creates a knowledge base category in the default locale. Required scope: knowledgebases:write
POST /knowledge_bases/{knowledge_base_id}/categories - Write
Create knowledge base category in specified locale
Creates a knowledge base category for a given locale. Required scope: knowledgebases:write
POST /knowledge_bases/{knowledge_base_id}/locales/{locale}/categories - Write
Update knowledge base in default locale
Updates a knowledge base in the default locale. Will republish the knowledge base if the knowledge base is currently published. Required scope: knowledgebases:write
PATCH /knowledge_bases/{knowledge_base_id}/content - Write
Update knowledge base in specified locale
Updates a knowledge base for a given locale. Will republish the knowledge base if the knowledge base is currently published. Required scope: knowledgebases:write
PATCH /knowledge_bases/{knowledge_base_id}/locales/{locale}/content
Analytics
- Read
Fetch an analytics export
Fetch an analytics exports. Refer to the Analytics topic for details about specific metrics. Required scope: analytics:read
GET /analytics/exports/{export_id} - Read
Fetch an analytics report
Fetch an analytics report. Refer to the Analytics topic for details about specific metrics. Required scope: analytics:read
GET /analytics/reports/{report_uid} - Write
Create a new analytics export
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 topic for details about specific metrics. Required scope: analytics:read
POST /analytics/exports - Write
Create a new analytics report
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 topic for details about specific metrics. Required scope: analytics:read
POST /analytics/reports
Message Template Folders
- Read
Get child folders
Fetch the child message templates folders of a message template folder. Required scope: messagetemplates:read
GET /message_template_folders/{message_template_folder_id}/message_template_folders - Read
Get folder
Fetch a message template folder. Required scope: messagetemplates:read
GET /message_template_folders/{message_template_folder_id} - Read
List folders
List the message template folders. Required scope: messagetemplates:read
GET /message_template_folders - Read
List team folders
List the message template folders belonging to the requested team (workspace). Required scope: messagetemplates:read
GET /teams/{team_id}/message_template_folders - Read
List teammate folders
List the message template folders belonging to the requested teammate. Required scope: messagetemplates:read
GET /teammates/{teammate_id}/message_template_folders - Write
Create child folder
Create a new message template folder as a child of the given folder Required scope: messagetemplates:write
POST /message_template_folders/{message_template_folder_id}/message_template_folders - Write
Create folder
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 endpoint instead. Required scope: messagetemplates:write
POST /message_template_folders - Write
Create team folder
Create a new message template folder belonging to the requested team (workspace). Required scope: messagetemplates:write
POST /teams/{team_id}/message_template_folders - Write
Create teammate folder
Create a new message template folder belonging to the requested teammate. Required scope: messagetemplates:write
POST /teammates/{teammate_id}/message_template_folders - Write
Update folder
Update message template folder Required scope: messagetemplates:write
PATCH /message_template_folders/{message_template_folder_id} - Destructive
Delete folder
Delete a message template folder and child folders/templates Required scope: messagetemplates:delete
DELETE /message_template_folders/{message_template_folder_id}
Tags
- Read
Get tag
Fetch a tag. Required scope: tags:read
GET /tags/{tag_id} - Read
List company tags
List the company tags. Required scope: tags:read
GET /company/tags - Read
List tag children
List the children of a specific tag. Required scope: tags:read
GET /tags/{tag_id}/children - Read
List tagged conversations
List the conversations tagged with a tag. For more advanced filtering, see the search endpoint. Required scope: conversations:read
GET /tags/{tag_id}/conversations - Read
List tags
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
GET /tags - Read
List team tags
List the tags for a team (workspace). Required scope: tags:read
GET /teams/{team_id}/tags - Read
List teammate tags
List the tags for a teammate. Required scope: tags:read
GET /teammates/{teammate_id}/tags - Write
Create child tag
Creates a child tag. Required scope: tags:write
POST /tags/{tag_id}/children - Write
Create company tag
Create a company tag. Required scope: tags:write
POST /company/tags - Write
Create tag
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
POST /tags - Write
Create team tag
Create a tag for a team (workspace). Required scope: tags:write
POST /teams/{team_id}/tags - Write
Create teammate tag
Create a tag for a teammate. Required scope: tags:write
POST /teammates/{teammate_id}/tags - Write
Update a tag
Update a tag. Required scope: tags:write
PATCH /tags/{tag_id} - Destructive
Delete tag
Delete a tag. Required scope: tags:delete
DELETE /tags/{tag_id}
Message Templates
- Read
Get child templates
Fetch the child message templates of a message template folder. Required scope: messagetemplates:read
GET /message_template_folders/{message_template_folder_id}/message_templates - Read
Get message template
Fetch a message template. Required scope: messagetemplates:read
GET /message_templates/{message_template_id} - Read
List message templates
List the message templates. Required scope: messagetemplates:read
GET /message_templates - Read
List team message templates
List the message templates belonging to the requested team (workspace). Required scope: messagetemplates:read
GET /teams/{team_id}/message_templates - Read
List teammate message templates
List the message templates belonging to the requested teammate. Required scope: messagetemplates:read
GET /teammates/{teammate_id}/message_templates - Write
Create child template
Create a new message template as a child of the given folder Required scope: messagetemplates:write
POST /message_template_folders/{message_template_folder_id}/message_templates - Write
Create message template
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 endpoint instead. Required scope: messagetemplates:write
POST /message_templates - Write
Create team message template
Create a new message template for the given team (workspace). Required scope: messagetemplates:write
POST /teams/{team_id}/message_templates - Write
Create teammate message template
Create a new message template for the given teammate Required scope: messagetemplates:write
POST /teammates/{teammate_id}/message_templates - Write
Update message template
Update a message template. Required scope: messagetemplates:write
PATCH /message_templates/{message_template_id} - Destructive
Delete message template
Delete a message template Required scope: messagetemplates:delete
DELETE /message_templates/{message_template_id}
Contacts
- Read
Get contact
Fetch a contact. Required scope: contacts:read
GET /contacts/{contact_id} - Read
List contact conversations
List the conversations for a contact in reverse chronological order (newest first). For more advanced filtering, see the search endpoint. Required scope: conversations:read
GET /contacts/{contact_id}/conversations - Read
List contacts
List the contacts of the company. Required scope: contacts:read
GET /contacts - Read
List team contacts
List the contacts of a team (workspace). Required scope: contacts:read
GET /teams/{team_id}/contacts - Read
List teammate contacts
List the contacts of a teammate. Required scope: contacts:read
GET /teammates/{teammate_id}/contacts - Write
Create contact
Create a new contact at the company level. Required scope: contacts:write
POST /contacts - Write
Create team contact
Create a contact for a team (workspace). Required scope: contacts:write
POST /teams/{team_id}/contacts - Write
Create teammate contact
Create a contact for a teammate. Required scope: contacts:write
POST /teammates/{teammate_id}/contacts - Write
Update a contact
Updates a contact. Required scope: contacts:write
PATCH /contacts/{contact_id} - Destructive
Delete a contact
Delete a contact. Required scope: contacts:delete
DELETE /contacts/{contact_id} - Destructive
Merge contacts
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
POST /contacts/merge
Drafts
- Read
List conversation drafts
List the drafts in a conversation. Required scope: drafts:read
GET /conversations/{conversation_id}/drafts - Write
Create draft
Create a draft message which is the first message of a new conversation. Required scope: drafts:write
POST /channels/{channel_id}/drafts - Write
Create draft reply
Create a new draft as a reply to the last message in the conversation. Required scope: drafts:write
POST /conversations/{conversation_id}/drafts - Write
Edit draft
Edit a draft message. Required scope: drafts:write
PATCH /drafts/{message_id} - Destructive
Delete draft
Delete a draft message. Required scope: drafts:delete
DELETE /drafts/{draft_id}
Links
- Read
Get link
Fetch a link. For more information on links, see the Links topic. Required scope: links:read
GET /links/{link_id} - Read
List link conversations
List the conversations linked to a specific link. For more advanced filtering, see the search endpoint. For more information on links, see the Links topic. Required scope: conversations:read
GET /links/{link_id}/conversations - Read
List links
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 topic. Required scope: links:read
GET /links - Write
Create link
Create a link. You must supply either pattern or externalurl in the request, but not both (pattern is for application objects while externalurl 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
POST /links - Write
Update a link
Update a link. For more information on links, see the Links topic. Required scope: links:write
PATCH /links/{link_id}
Messages
- Read
Get message
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 /messages/{message_id} - Read
Get message seen status
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
GET /messages/{message_id}/seen - Write
Create message
Send a new message from a channel. This is one of the ways to create a new conversation. The new conversation will support both messages and comments (discussions). Required scope: messages:send
POST /channels/{channel_id}/messages - Write
Create message reply
Reply to a conversation by sending a message and appending it to the conversation. Required scope: messages:send
POST /conversations/{conversation_id}/messages - Write
Import message
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 endpoint to send (rather than import) a new message. Required scope: messages:write
POST /inboxes/{inbox_id}/imported_messages - Write
Mark message seen
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
POST /messages/{message_id}/seen - Write
Receive custom messages
Receive a custom message in Front. This endpoint is available for custom channels ONLY. Required scope: messages:write
POST /channels/{channel_id}/incoming_messages
Signatures
- Read
Get signatures
Get the given signature. Required scope: signatures:read
GET /signatures/{signature_id} - Read
List team signatures
List the signatures belonging to the given team (workspace). Required scope: signatures:read
GET /teams/{team_id}/signatures - Read
List teammate signatures
List the signatures belonging to the given teammate. Required scope: signatures:read
GET /teammates/{teammate_id}/signatures - Write
Create team signature
Create a new signature for the given team (workspace). Required scope: signatures:write
POST /teams/{team_id}/signatures - Write
Create teammate signature
Create a new signature for the given teammate Required scope: signatures:write
POST /teammates/{teammate_id}/signatures - Write
Update signature
Update signature Required scope: signatures:write
PATCH /signatures/{signature_id} - Destructive
Delete signature
Delete signature Required scope: signatures:delete
DELETE /signatures/{signature_id}
Time Off
- Read
Get time off
Fetch a time off. Required scope: timeoff:read
GET /time_offs/{time_off_id} - Read
List team time offs
List the time offs of all teammates in a team. Required scope: timeoff:read
GET /teams/{team_id}/time_offs - Read
List teammate time offs
List the time offs of a teammate. Required scope: timeoff:read
GET /teammates/{teammate_id}/time_offs - Write
Create time off
Create a time off for a teammate. Required scope: timeoff:write
POST /teammates/{teammate_id}/time_offs - Write
Update time off
Update a time off. Required scope: timeoff:write
PATCH /time_offs/{time_off_id} - Destructive
Delete time off
Delete a time off. Required scope: timeoff:delete
DELETE /time_offs/{time_off_id}
Knowledge Base Categories
- Read
Get a knowledge base category
Fetches a knowledge base category. Required scope: knowledgebases:read
GET /knowledge_base_categories/{category_id} - Read
Get knowledge base category content in default locale
Fetches a knowledge base category with content in the default locale. Required scope: knowledgebases:read
GET /knowledge_base_categories/{category_id}/content - Read
Get knowledge base category with content in specified locale
Fetches a knowledge base category with content for a given locale. Required scope: knowledgebases:read
GET /knowledge_base_categories/{category_id}/locales/{locale}/content - Read
List categories in a knowledge base
List categories in a knowledge base. Required scope: knowledgebases:read
GET /knowledge_bases/{knowledge_base_id}/categories - Write
Update knowledge base category in default locale
Updates a knowledge base category in the default locale. Will republish the knowledge base if the knowledge base is currently published. Required scope: knowledgebases:write
PATCH /knowledge_base_categories/{category_id}/content - Write
Update knowledge base category in specified locale
Updates a knowledge base category for a given locale. Will republish the knowledge base if the knowledge base is currently published. Required scope: knowledgebases:write
PATCH /knowledge_base_categories/{category_id}/locales/{locale}/content - Destructive
Delete a knowledge base category
Deletes a knowledge base category. ⚠️ Warning When a category is deleted, all articles in the category are also deleted. Required scope: knowledgebases:delete
DELETE /knowledge_base_categories/{category_id}
Knowledge Base Articles
- Read
Download attachment from an article
Downloads the attachment from an article. Required scope: knowledgebases:read
GET /knowledge_base_articles/{article_id}/download/{attachment_id} - Read
Get a knowledge base article
Fetches a knowledge base article. Required scope: knowledgebases:read
GET /knowledge_base_articles/{article_id} - Read
Get knowledge base article with content in default locale
Fetches a knowledge base article with content in the default locale. Required scope: knowledgebases:read
GET /knowledge_base_articles/{article_id}/content - Read
Get knowledge base article with content in specified locale
Fetches a knowledge base article with content for a given locale. Required scope: knowledgebases:read
GET /knowledge_base_articles/{article_id}/locales/{locale}/content - Read
List articles in a category
List articles in a category. Required scope: knowledgebases:read
GET /knowledge_base_categories/{category_id}/articles - Read
List articles in a knowledge base
List articles in a knowledge base Required scope: knowledgebases:read
GET /knowledge_bases/{knowledge_base_id}/articles - Write
Update article content in default locale.
Updates an article's content in the default locale Required scope: knowledgebases:write
PATCH /knowledge_base_articles/{article_id}/content - Write
Update article content in specified locale
Updates an article's content for a given locale. Required scope: knowledgebases:write
PATCH /knowledge_base_articles/{article_id}/locales/{locale}/content - Destructive
Delete an article
Deletes an article and all its content and translations. Required scope: knowledgebases:delete
DELETE /knowledge_base_articles/{article_id}
Attachments
- Read
Download attachment
Download an attachment file. Required scope: attachments:read
GET /download/{attachment_link_id} - Read
Download attachment for a comment
Download an attachment file for a given comment ID Required scope: attachments:read
GET /comments/{comment_id}/download/{attachment_link_id} - Read
Download attachment for a message
Download an attachment file for a given message id. Should be used by partner channels. Required scope: attachments:read
GET /messages/{message_id}/download/{attachment_link_id} - Read
Download attachment for a message template
Download an attachment file for a given message template ID Required scope: attachments:read
GET /message_templates/{message_template_id}/download/{attachment_link_id}
Events
- Read
Get event
Fetch an event. Refer to the Events topic for more information, including sorting and filtering. Required scope: events::read
GET /events/{event_id} - Read
List events
Lists all the detailed events which occurred in the inboxes of the company ordered in reverse chronological order (newest first). Refer to the Events topic for more information, including sorting and filtering. Required scope: events::read
GET /events
Rules
- Read
Get rule
Fetch a rule. Required scope: rules:read
GET /rules/{rule_id} - Read
List all company rules
List the company rules. Required scope: rules:read
GET /company/rules - Read
List rules
List the rules of the company. Required scope: rules:read
GET /rules - Read
List team rules
List the rules of a team (workspace). Required scope: rules:read
GET /teams/{team_id}/rules - Read
List teammate rules
List the rules of a teammate. Required scope: rules:read
GET /teammates/{teammate_id}/rules
Teammates
- Read
Get teammate
Fetch a teammate. Required scope: teammates:read
GET /teammates/{teammate_id} - Read
List assigned conversations
List the conversations assigned to a teammate in reverse chronological order (most recently updated first). For more advanced filtering, see the search endpoint. Required scope: conversations:read
GET /teammates/{teammate_id}/conversations - Read
List teammate inboxes (deprecated)
Returns list of inboxes the teammate has access to. Required scope: inboxes:read
GET /teammates/{teammate_id}/inboxes - Read
List teammates
List the teammates in the company. Required scope: teammates:read
GET /teammates - Write
Update teammate
Update a teammate. Required scope: teammates:write
PATCH /teammates/{teammate_id}
Statuses
- Read
Get ticket status
Fetch a ticket status. Required scope: statuses:read
GET /company/statuses/{status_id} - Read
List company ticket statuses
List the ticket statuses available for your company. Required scope: statuses:read
GET /company/statuses
Custom Fields
- Read
List Account's custom fields
Lists the custom fields that can be attached to an Account. Required scope: customfields:read
GET /accounts/custom_fields - Read
List Contact's custom fields
Lists the custom fields that can be attached to a Contact. Required scope: customfields:read
GET /contacts/custom_fields - Read
List Conversation's custom fields
Lists customer-managed custom fields that can be attached to a Conversation. Front-managed system fields are excluded. Required scope: customfields:read
GET /conversations/custom_fields - Read
List Contact's custom fields (deprecated)
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/customfields endpoint instead. Required scope: customfields:read
GET /custom_fields - Read
List Inbox's custom fields
Lists the custom fields that can be attached to an Inbox. Required scope: customfields:read
GET /inboxes/custom_fields - Read
List Link's custom fields
Lists the custom fields that can be attached to a Link. For more information on links, see the Links topic. Required scope: customfields:read
GET /links/custom_fields - Read
List Teammate's custom fields
Lists the custom fields that can be attached to a Teammate. Required scope: customfields:read
GET /teammates/custom_fields
Applications
- Write
Trigger application event
Triggers an event on behalf of an application. These events can trigger Front workflows, like rules. For more information, see the developer docs. Required scope: feature:apptrigger
POST /applications/{application_uid}/events
No operations match.
Get started
- Open Space settings → Connections and search for Front.
- Connect your account and add the connection to the Space.
- Ask for what you need in any thread in that Space.
See How connections work for access and permissions, or browse all integrations.