Skip to content
Scalekit Docs
Talk to an EngineerDashboard

Front

scalekit55 toolsOAuth 2.0CommunicationCustomer Support

Connect to Front to manage conversations, messages, comments, drafts, contacts, tags, inboxes, teammates, and channels.

Front connector

  1. Install the SDK

    Section titled “Install the SDK”
    Terminal window
    npm install @scalekit-sdk/node

    Full SDK reference: Node.js | Python

  2. Set your credentials

    Section titled “Set your credentials”

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>

  3. Authorize and make your first call

    Section titled “Authorize and make your first call”
    quickstart.ts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    

    const scalekit = new ScalekitClient(
      process.env.SCALEKIT_ENV_URL,
      process.env.SCALEKIT_CLIENT_ID,
      process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    

    const connector = 'front'
    const identifier = 'user_123'
    

    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Front:', link)
    process.stdout.write('Press Enter after authorizing...')
    await new Promise(r => process.stdin.once('data', r))
    

    // Make your first call
    const result = await actions.executeTool({
      connector,
      identifier,
      toolName: 'front_list_accounts',
      toolInput: {},
    })
    console.log(result)

What you can do

Section titled “What you can do”

Connect this agent connector to let your agent:

  • Update teammate, tag, conversation assignee — Update a teammate’s username, name, or availability status in Front
  • Send message — Send a new outbound message from a Front channel
  • Search conversations — Search for conversations
  • Conversation reply to — Reply to a conversation by sending a message and appending it to the conversation
  • Tag remove conversation, add conversation — Remove one or more tags from a conversation
  • Message receive, import — Receive a custom message in Front

Tool list

Section titled “Tool list”

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

front_add_contact_handle#Add a new handle (e.g. email, phone, Twitter) to an existing contact.5 params

Add a new handle (e.g. email, phone, Twitter) to an existing contact.

NameTypeRequiredDescription
contact_idstringrequiredThe contact ID. Alternatively, you can supply the contact's source and handle as a resource alias.
handlestringrequiredHandle used to reach the contact.
sourcestringrequiredSource of the handle.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_add_contact_note#Create a new note on a contact, authored by a specific teammate.5 params

Create a new note on a contact, authored by a specific teammate.

NameTypeRequiredDescription
author_idstringrequiredID of the teammate creating the note.
bodystringrequiredContent of the note.
contact_idstringrequiredThe contact ID. Alternatively, you can supply the contact's source and handle as a resource alias.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_add_conversation_comment#Add an internal comment to a Front conversation. Comments are only visible to teammates, not to external recipients. Requires scope comments:write. To start a brand-new comment-only conversation, use the Create Discussion Conversation endpoint instead.6 params

Add an internal comment to a Front conversation. Comments are only visible to teammates, not to external recipients. Requires scope comments:write. To start a brand-new comment-only conversation, use the Create Discussion Conversation endpoint instead.

NameTypeRequiredDescription
bodystringrequiredContent of the comment. Can include markdown formatting.
conversation_idstringrequiredThe unique Front identifier for the conversation to comment on, e.g. cnv_123.
author_idstringoptionalID of the teammate creating the comment, e.g. tea_123. If omitted, the comment posts as the API token or OAuth client of the requester.
is_pinnedbooleanoptionalWhether or not the comment is pinned in its conversation.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_add_conversation_tag#Add one or more tags to a conversation. Required scope: conversations:write.4 params

Add one or more tags to a conversation. Required scope: conversations:write.

NameTypeRequiredDescription
conversation_idstringrequiredThe conversation ID.
tag_idsarrayrequiredTag IDs to add to the conversation.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_create_contact#Create a new contact at the company level, with one or more handles (e.g. email, phone, Twitter).8 params

Create a new contact at the company level, with one or more handles (e.g. email, phone, Twitter).

NameTypeRequiredDescription
handlesarrayrequiredList of handles for this contact. Each item is an object with 'handle' and 'source' fields, e.g. [{"handle": "dwight@limitlesspaper.com", "source": "email"}].
custom_fieldsobjectoptionalCustom fields for this contact, keyed by the custom field name defined in the Front UI.
descriptionstringoptionalContact description.
linksarrayoptionalList of links associated with the contact.
list_namesarrayoptionalList of contact list names the contact belongs to. Missing lists will be created automatically.
namestringoptionalContact name.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_create_conversation#Create a new conversation of type discussion or task. Both types only support comments. To create a conversation that supports messages, use the Reply To Conversation / channel message endpoints instead. Required scope: conversations:write.11 params

Create a new conversation of type discussion or task. Both types only support comments. To create a conversation that supports messages, use the Reply To Conversation / channel message endpoints instead. Required scope: conversations:write.

NameTypeRequiredDescription
subjectstringrequiredSubject of the conversation. Used as the title for tasks.
typestringrequiredConversation type.
comment_author_idstringoptionalID of the teammate creating the comment. If omitted, will post as the API token or OAuth client of the requester.
comment_bodystringoptionalContent of the starter comment. Required for discussions, optional for tasks.
custom_fieldsobjectoptionalCustom fields for this conversation, sent as an object of key:value pairs.
descriptionstringoptionalDescription of the task. Only allowed when type is task.
due_atnumberoptionalUnix timestamp in seconds when the task is due. Must be in the future and within 50 years. Only allowed when type is task.
inbox_idstringoptionalInbox ID for the conversation. Either inbox_id OR teammate_ids must be provided (not both).
schema_versionstringoptionalSchema version
teammate_idsarrayoptionalTeammates to add to the conversation. Either inbox_id OR teammate_ids must be provided (not both).
tool_versionstringoptionalTool version
front_create_draft#Create a draft message that becomes the first message of a new Front conversation. Requires scope drafts:write.13 params

Create a draft message that becomes the first message of a new Front conversation. Requires scope drafts:write.

NameTypeRequiredDescription
bodystringrequiredBody of the draft.
channel_idstringrequiredThe channel ID to create the draft from, e.g. cha_123. Alternatively, supply the channel's address as a resource alias.
author_idstringoptionalID of the teammate on behalf of whom the draft is created, e.g. tea_123. If omitted, the draft is created as the API token or application making the request.
bccarrayoptionalList of recipient handles who will receive a blind copy of the message once the draft is sent.
ccarrayoptionalList of recipient handles who will receive a copy of the message once the draft is sent.
modestringoptionalMode of the draft to create. Can be 'private' (visible to the author only) or 'shared' (visible to all teammates with access to the conversation). Defaults to private.
quote_bodystringoptionalBody for the quote that the message is referencing. Only available on email channels.
schema_versionstringoptionalSchema version
should_add_default_signaturebooleanoptionalWhether Front should try to resolve a signature for the message. Ignored if signature_id is set. Defaults to false.
signature_idstringoptionalID of the signature to attach to this draft. If null, no signature is attached.
subjectstringoptionalSubject of the draft.
toarrayoptionalList of recipient handles who will receive the message once the draft is sent.
tool_versionstringoptionalTool version
front_create_draft_reply#Create a new draft as a reply to the last message in a Front conversation. Requires scope drafts:write.14 params

Create a new draft as a reply to the last message in a Front conversation. Requires scope drafts:write.

NameTypeRequiredDescription
bodystringrequiredBody of the draft.
channel_idstringrequiredID of the channel from which the draft will be sent, e.g. cha_123. Alternatively, supply the channel's address as a resource alias.
conversation_idstringrequiredThe unique Front identifier for the conversation to reply to, e.g. cnv_123.
author_idstringoptionalID of the teammate on behalf of whom the draft is created, e.g. tea_123. If omitted, the draft is created as the API token or application making the request.
bccarrayoptionalList of the recipient handles who will receive a blind copy of the message once the draft is sent.
ccarrayoptionalList of recipient handles who will receive a copy of the message once the draft is sent.
modestringoptionalMode of the draft to create. Can be 'private' (visible to the author only) or 'shared' (visible to all teammates with access to the conversation). Defaults to private.
quote_bodystringoptionalBody for the quote that the message is referencing. Only available on email channels.
schema_versionstringoptionalSchema version
should_add_default_signaturebooleanoptionalWhether Front should try to resolve a signature for the message. Ignored if signature_id is set. Defaults to false.
signature_idstringoptionalID of the signature to attach to this draft. If null, no signature is attached.
subjectstringoptionalSubject of the draft.
toarrayoptionalList of recipient handles who will receive the message once the draft is sent.
tool_versionstringoptionalTool version
front_create_tag#Create a tag in the oldest team (workspace) accessible to the API token. This is a legacy endpoint; prefer the Create Company Tag, Create Team Tag, or Create Teammate Tag endpoints when you need to target a specific scope. Requires the tags:write scope.6 params

Create a tag in the oldest team (workspace) accessible to the API token. This is a legacy endpoint; prefer the Create Company Tag, Create Team Tag, or Create Teammate Tag endpoints when you need to target a specific scope. Requires the tags:write scope.

NameTypeRequiredDescription
namestringrequiredName of the tag to create. Maximum length is 64 characters.
descriptionstringoptionalOptional description of the tag's purpose.
highlightstringoptionalHighlight color of the tag. One of: grey, pink, red, orange, yellow, green, light-blue, blue, purple.
is_visible_in_conversation_listsbooleanoptionalWhether the tag is visible in conversation lists. Defaults to false.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_delete_contact#Permanently delete a contact by its Front contact ID.3 params

Permanently delete a contact by its Front contact ID.

NameTypeRequiredDescription
contact_idstringrequiredThe contact ID. Alternatively, you can supply the contact's source and handle as a resource alias.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_delete_draft#Permanently delete a draft message in Front. Requires the current draft version and scope drafts:delete.4 params

Permanently delete a draft message in Front. Requires the current draft version and scope drafts:delete.

NameTypeRequiredDescription
draft_idstringrequiredThe unique Front identifier for the draft to delete, e.g. msg_123.
versionstringrequiredVersion of the draft to delete, used to prevent deleting a draft that has since changed. Obtain this from a prior Get Message call.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_delete_tag#Permanently delete a tag from Front by its ID. This removes the tag from all conversations it was applied to and cannot be undone. Requires the tags:delete scope.3 params

Permanently delete a tag from Front by its ID. This removes the tag from all conversations it was applied to and cannot be undone. Requires the tags:delete scope.

NameTypeRequiredDescription
tag_idstringrequiredThe unique Front identifier of the tag to delete, e.g. 'tag_123'.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_edit_draft#Edit an existing draft message in Front. Requires scope drafts:write.15 params

Edit an existing draft message in Front. Requires scope drafts:write.

NameTypeRequiredDescription
bodystringrequiredBody of the draft.
channel_idstringrequiredID of the channel from which the draft will be sent, e.g. cha_123. Alternatively, supply the channel's address as a resource alias.
message_idstringrequiredThe unique Front identifier for the draft to edit, e.g. msg_123.
versionstringrequiredVersion of the draft being edited, used for optimistic concurrency control.
author_idstringoptionalID of the teammate on behalf of whom the draft is edited, e.g. tea_123.
bccarrayoptionalList of the recipient handles who will receive a blind copy of the message once the draft is sent.
ccarrayoptionalList of recipient handles who will receive a copy of the message once the draft is sent.
modestringoptionalMode of the draft to update. Can only be 'shared' (visible to all teammates with access to the conversation) when editing.
quote_bodystringoptionalBody for the quote that the message is referencing. Only available on email channels.
schema_versionstringoptionalSchema version
should_add_default_signaturebooleanoptionalWhether Front should try to resolve a signature for the message. Ignored if signature_id is set. Defaults to false.
signature_idstringoptionalID of the signature to attach to this draft. If null, no signature is attached.
subjectstringoptionalSubject of the draft.
toarrayoptionalList of recipient handles who will receive the message once the draft is sent.
tool_versionstringoptionalTool version
front_get_account#Fetch a single account from Front by ID, domain, or external ID resource alias.3 params

Fetch a single account from Front by ID, domain, or external ID resource alias.

NameTypeRequiredDescription
account_idstringrequiredThe Account ID. Alternatively, you can supply the account domain or external ID as a resource alias.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_get_channel#Fetch a single channel from Front by ID or address resource alias.3 params

Fetch a single channel from Front by ID or address resource alias.

NameTypeRequiredDescription
channel_idstringrequiredThe Channel ID. Alternatively, you can supply the channel address as a resource alias.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_get_comment#Fetch a single Front comment by its ID. Requires scope comments:read.3 params

Fetch a single Front comment by its ID. Requires scope comments:read.

NameTypeRequiredDescription
comment_idstringrequiredThe unique Front identifier for the comment to fetch, e.g. com_123.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_get_contact#Fetch a single contact by its Front contact ID.3 params

Fetch a single contact by its Front contact ID.

NameTypeRequiredDescription
contact_idstringrequiredThe contact ID. Alternatively, you can supply the contact's source and handle as a resource alias.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_get_conversation#Fetch a single conversation by its ID. Required scope: conversations:read.3 params

Fetch a single conversation by its ID. Required scope: conversations:read.

NameTypeRequiredDescription
conversation_idstringrequiredThe conversation ID.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_get_inbox#Fetch a single Front inbox by its ID, returning its name, type, and related resource links. Requires the inboxes:read scope.3 params

Fetch a single Front inbox by its ID, returning its name, type, and related resource links. Requires the inboxes:read scope.

NameTypeRequiredDescription
inbox_idstringrequiredThe unique Front identifier of the inbox to fetch, e.g. 'inb_123'.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_get_message#Fetch a single Front message by its ID, including its body, recipients, and attachment metadata. Requires scope messages:read.3 params

Fetch a single Front message by its ID, including its body, recipients, and attachment metadata. Requires scope messages:read.

NameTypeRequiredDescription
message_idstringrequiredThe unique Front identifier for the message to fetch, e.g. msg_123.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_get_message_template#Fetch a single message template (canned answer) by its ID from Front.3 params

Fetch a single message template (canned answer) by its ID from Front.

NameTypeRequiredDescription
message_template_idstringrequiredThe message template ID.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_get_tag#Fetch a single Front tag by its ID, returning its name, highlight color, visibility settings, and related resource links. Requires the tags:read scope.3 params

Fetch a single Front tag by its ID, returning its name, highlight color, visibility settings, and related resource links. Requires the tags:read scope.

NameTypeRequiredDescription
tag_idstringrequiredThe unique Front identifier of the tag to fetch, e.g. 'tag_123'.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_get_teammate#Fetch a single teammate from Front by ID or email resource alias.3 params

Fetch a single teammate from Front by ID or email resource alias.

NameTypeRequiredDescription
teammate_idstringrequiredThe teammate ID. Alternatively, you can supply an email as a resource alias.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_import_message#Import a message into a Front inbox without sending it through a live channel. Use this for historical conversations or non-standard sources (e.g. web form submissions) rather than for sending new outbound messages, which should use Send Message instead. Requires scope messages:write.22 params

Import a message into a Front inbox without sending it through a live channel. Use this for historical conversations or non-standard sources (e.g. web form submissions) rather than for sending new outbound messages, which should use Send Message instead. Requires scope messages:write.

NameTypeRequiredDescription
bodystringrequiredBody of the message.
created_atintegerrequiredUnix timestamp (seconds) of when the message was sent or received.
external_idstringrequiredExternal identifier of the message. Front will not import two messages with the same external ID.
inbox_idstringrequiredThe unique Front identifier for the inbox to import the message into, e.g. inb_123.
metadata_is_inboundbooleanrequiredDetermines if the message is received (inbound) or sent (outbound) by you.
sender_handlestringrequiredHandle of the sender, any string that uniquely identifies them (e.g. an email address or phone number). For phone numbers, include a country code preceded by a plus sign (e.g. +33) or it will be normalized to the USA (+1).
toarrayrequiredList of recipient handles who received this message.
assignee_idstringoptionalID of the teammate who will be assigned to the conversation, e.g. tea_123.
bccarrayoptionalList of recipient handles who received a blind copy of this message.
body_formatstringoptionalFormat of the message body. Can be markdown (default) or html. Only applicable for email type messages.
ccarrayoptionalList of recipient handles who received a copy of this message.
conversation_idstringoptionalIf supplied, Front threads this message into the conversation with the given ID. Supplying this nullifies metadata_thread_ref completely.
metadata_is_archivedbooleanoptionalDetermines if the message is archived after import. Defaults to true.
metadata_should_skip_rulesbooleanoptionalDetermines if automation rules should be skipped for this import. Defaults to true.
metadata_thread_refstringoptionalReference used to thread messages together. If omitted, Front threads by sender instead. Unique to importing historical messages.
schema_versionstringoptionalSchema version
sender_author_idstringoptionalID of the teammate who authored the message, e.g. tea_123. Ignored if the message is inbound.
sender_namestringoptionalName of the sender.
subjectstringoptionalSubject of the message.
tagsarrayoptionalList of tag names to add to the conversation.
tool_versionstringoptionalTool version
typestringoptionalType of the message to import. Default is email.
front_list_accounts#List the accounts of the Front company, with optional pagination.4 params

List the accounts of the Front company, with optional pagination.

NameTypeRequiredDescription
limitintegeroptionalMax number of results per page.
page_tokenstringoptionalToken to use to request the next page.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_list_channels#List the channels of the Front company.2 params

List the channels of the Front company.

NameTypeRequiredDescription
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_list_contact_groups#List the contact groups in Front. This is a deprecated Front endpoint; Front recommends using the contact lists endpoints instead, but this remains supported for existing integrations.2 params

List the contact groups in Front. This is a deprecated Front endpoint; Front recommends using the contact lists endpoints instead, but this remains supported for existing integrations.

NameTypeRequiredDescription
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_list_contact_notes#List the notes added to a contact.3 params

List the notes added to a contact.

NameTypeRequiredDescription
contact_idstringrequiredThe contact ID. Alternatively, you can supply the contact's source and handle as a resource alias.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_list_contacts#List the contacts of the company, with optional search query, sorting, and pagination.7 params

List the contacts of the company, with optional search query, sorting, and pagination.

NameTypeRequiredDescription
limitintegeroptionalMax number of results per page.
page_tokenstringoptionalToken to use to request the next page of results.
qstringoptionalSearch query object with optional properties updated_after and updated_before, as a JSON string.
schema_versionstringoptionalSchema version
sort_bystringoptionalField used to sort the contacts. Either created_at or updated_at.
sort_orderstringoptionalOrder by which results should be sorted.
tool_versionstringoptionalTool version
front_list_conversation_comments#List the comments in a Front conversation in reverse chronological order (newest first). Requires scope comments:read.3 params

List the comments in a Front conversation in reverse chronological order (newest first). Requires scope comments:read.

NameTypeRequiredDescription
conversation_idstringrequiredThe unique Front identifier for the conversation whose comments should be listed, e.g. cnv_123.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_list_conversation_messages#List the messages in a conversation in reverse chronological order (newest first). Required scope: messages:read.7 params

List the messages in a conversation in reverse chronological order (newest first). Required scope: messages:read.

NameTypeRequiredDescription
conversation_idstringrequiredThe conversation ID.
limitintegeroptionalMax number of results per page (maximum 100).
page_tokenstringoptionalToken to use to request the next page.
schema_versionstringoptionalSchema version
sort_bystringoptionalField used to sort the messages. Only supports 'created_at'.
sort_orderstringoptionalOrder by which results should be sorted.
tool_versionstringoptionalTool version
front_list_conversations#List the conversations in the company in reverse chronological order (most recently updated first). For more advanced filtering, use the search endpoint. Required scope: conversations:read.7 params

List the conversations in the company in reverse chronological order (most recently updated first). For more advanced filtering, use the search endpoint. Required scope: conversations:read.

NameTypeRequiredDescription
limitintegeroptionalMax number of results per page (maximum 100).
page_tokenstringoptionalToken to use to request the next page.
qstringoptionalSearch query object with a property `statuses`, whose value should be a list of conversation statuses (assigned, unassigned, archived, or trashed). If ticketing is enabled, this endpoint accepts either status_categories (open, waiting, resolved) or status_ids as an alternative.
schema_versionstringoptionalSchema version
sort_bystringoptionalField used to sort the conversations. Only supports 'date'.
sort_orderstringoptionalOrder by which results should be sorted.
tool_versionstringoptionalTool version
front_list_custom_fields#List the custom fields that can be attached to a contact in Front. Note: this endpoint is deprecated by Front in favor of GET /contacts/custom_fields, but remains functional.2 params

List the custom fields that can be attached to a contact in Front. Note: this endpoint is deprecated by Front in favor of GET /contacts/custom_fields, but remains functional.

NameTypeRequiredDescription
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_list_inbox_channels#List all channels (e.g. email addresses, SMS numbers) attached to a specific Front inbox. Requires the channels:read scope.3 params

List all channels (e.g. email addresses, SMS numbers) attached to a specific Front inbox. Requires the channels:read scope.

NameTypeRequiredDescription
inbox_idstringrequiredThe unique Front identifier of the inbox whose channels should be listed, e.g. 'inb_123'.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_list_inbox_conversations#List the conversations in a specific Front inbox, with optional status filtering and pagination. For more advanced filtering use the conversation search endpoint instead. Requires the conversations:read scope.6 params

List the conversations in a specific Front inbox, with optional status filtering and pagination. For more advanced filtering use the conversation search endpoint instead. Requires the conversations:read scope.

NameTypeRequiredDescription
inbox_idstringrequiredThe unique Front identifier of the inbox whose conversations should be listed, e.g. 'inb_123'.
limitintegeroptionalMaximum number of results to return per page. Maximum allowed value is 100.
page_tokenstringoptionalPagination token used to request the next page of results. Use the token returned in the previous response's pagination links.
qstringoptionalSearch query object (as a JSON string) with a 'statuses' property whose value is a list of conversation statuses (assigned, unassigned, archived, or trashed). If ticketing is enabled, this can instead be 'status_categories' (open, waiting, resolved) or 'status_ids'.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_list_inboxes#List all inboxes in the Front company (workspace) that the API token has access to. Returns inbox IDs, names, and related resource links. Requires the inboxes:read scope.2 params

List all inboxes in the Front company (workspace) that the API token has access to. Returns inbox IDs, names, and related resource links. Requires the inboxes:read scope.

NameTypeRequiredDescription
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_list_kb_articles#List the articles in a given knowledge base in Front, with pagination support.5 params

List the articles in a given knowledge base in Front, with pagination support.

NameTypeRequiredDescription
knowledge_base_idstringrequiredThe ID of the knowledge base.
limitintegeroptionalMax number of results per page.
page_tokenstringoptionalToken to use to request the next page.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_list_knowledge_bases#List the knowledge bases of the company in Front.2 params

List the knowledge bases of the company in Front.

NameTypeRequiredDescription
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_list_message_templates#List the message templates (canned answers) available in the Front workspace, with optional sorting.4 params

List the message templates (canned answers) available in the Front workspace, with optional sorting.

NameTypeRequiredDescription
schema_versionstringoptionalSchema version
sort_bystringoptionalField used to sort the message templates.
sort_orderstringoptionalOrder by which results should be sorted.
tool_versionstringoptionalTool version
front_list_tags#List all tags that the API token has access to, whether they are company tags, team tags, or teammate tags, with optional sorting and pagination. Requires the tags:read scope.6 params

List all tags that the API token has access to, whether they are company tags, team tags, or teammate tags, with optional sorting and pagination. Requires the tags:read scope.

NameTypeRequiredDescription
limitintegeroptionalMaximum number of results to return per page. Maximum allowed value is 100.
page_tokenstringoptionalPagination token used to request the next page of results. Use the token returned in the previous response's pagination links.
schema_versionstringoptionalSchema version
sort_bystringoptionalField used to sort the tags. Only 'id' is supported.
sort_orderstringoptionalOrder by which results should be sorted. One of 'asc' or 'desc'.
tool_versionstringoptionalTool version
front_list_teammate_signatures#List the signatures belonging to a given teammate in Front.3 params

List the signatures belonging to a given teammate in Front.

NameTypeRequiredDescription
teammate_idstringrequiredThe teammate ID. Alternatively, you can supply an email as a resource alias.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_list_teammates#List the teammates in the Front company.2 params

List the teammates in the Front company.

NameTypeRequiredDescription
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_list_teams#List the teams (workspaces) in the Front company.2 params

List the teams (workspaces) in the Front company.

NameTypeRequiredDescription
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_receive_message#Receive a custom message in Front. Available for custom channels ONLY. Requires scope messages:write.10 params

Receive a custom message in Front. Available for custom channels ONLY. Requires scope messages:write.

NameTypeRequiredDescription
bodystringrequiredBody of the message.
channel_idstringrequiredThe custom channel ID, e.g. cha_123. Alternatively, supply the channel's address as a resource alias.
sender_handlestringrequiredHandle of the sender, any string that uniquely identifies them. For phone numbers, include a country code preceded by a plus sign (e.g. +33) or it will be normalized to the USA (+1).
body_formatstringoptionalFormat of the message body. Can be markdown (default) or html.
metadata_thread_refstringoptionalReference used to thread messages together. If omitted, Front threads by sender instead. Unique to custom channels.
schema_versionstringoptionalSchema version
sender_contact_idstringoptionalID of the contact in Front corresponding to the sender, e.g. crd_123.
sender_namestringoptionalName of the sender.
subjectstringoptionalSubject of the message.
tool_versionstringoptionalTool version
front_remove_conversation_tag#Remove one or more tags from a conversation. Required scope: conversations:write.4 params

Remove one or more tags from a conversation. Required scope: conversations:write.

NameTypeRequiredDescription
conversation_idstringrequiredThe conversation ID.
tag_idsarrayrequiredTag IDs to remove from the conversation.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_reply_to_conversation#Reply to a conversation by sending a message and appending it to the conversation. Required scope: messages:send.17 params

Reply to a conversation by sending a message and appending it to the conversation. Required scope: messages:send.

NameTypeRequiredDescription
bodystringrequiredBody of the message.
conversation_idstringrequiredThe conversation ID.
archivebooleanoptionalArchive the conversation right when sending the message. True by default.
author_idstringoptionalID of the teammate on behalf of whom the answer is sent.
bccarrayoptionalList of the recipient handles who will receive a copy of this message.
ccarrayoptionalList of the recipient handles who will receive a copy of this message.
channel_idstringoptionalChannel ID the message is sent from.
quote_bodystringoptionalBody for the quote that the message is referencing. Only available on email channels.
schema_versionstringoptionalSchema version
sender_namestringoptionalName used for the sender info of the message.
should_add_default_signaturebooleanoptionalWhether or not Front should try to resolve a signature for the message. Only applies to email channels and is ignored if signature_id is included or if author_id is omitted.
signature_idstringoptionalID of the signature to attach to this draft. Only supported for email channels; using this on other channel types returns a 403 forbidden error. If null, no signature is attached.
subjectstringoptionalSubject of the message for email message.
tag_idsarrayoptionalList of tag IDs to add to the conversation.
textstringoptionalText version of the body for email messages.
toarrayoptionalList of the recipient handles who will receive this message.
tool_versionstringoptionalTool version
front_search_conversations#Search for conversations. Response includes a count of total matches and an array of conversations in descending order by last activity. This endpoint is subject to proportional rate limiting at 40% of the company's rate limit. Required scope: conversations:read.5 params

Search for conversations. Response includes a count of total matches and an array of conversations in descending order by last activity. This endpoint is subject to proportional rate limiting at 40% of the company's rate limit. Required scope: conversations:read.

NameTypeRequiredDescription
querystringrequiredSearch query string. See Front's search syntax documentation for usage details.
limitintegeroptionalMax number of results per page (maximum 100).
page_tokenstringoptionalToken to use to request the next page.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_send_message#Send a new outbound message from a Front channel. This is one of the ways to create a new conversation; the resulting conversation supports both messages and comments. Requires scope messages:send. At least one of To, CC, or BCC must be provided.15 params

Send a new outbound message from a Front channel. This is one of the ways to create a new conversation; the resulting conversation supports both messages and comments. Requires scope messages:send. At least one of To, CC, or BCC must be provided.

NameTypeRequiredDescription
bodystringrequiredBody of the message.
channel_idstringrequiredThe sending channel ID, e.g. cha_123. Alternatively, supply the sending channel's address as a resource alias.
archivebooleanoptionalArchive the conversation right when sending the message. Defaults to true.
author_idstringoptionalID of the teammate on behalf of whom the message is sent, e.g. tea_123.
bccarrayoptionalList of recipient handles who will receive a blind copy of this message. At least one of to, cc, or bcc is required.
ccarrayoptionalList of recipient handles who will receive a copy of this message. At least one of to, cc, or bcc is required.
schema_versionstringoptionalSchema version
sender_namestringoptionalName used for the sender info of the message.
should_add_default_signaturebooleanoptionalWhether Front should try to resolve a signature for the message. Only applies to email channels and is ignored if signature_id is set or author_id is omitted. Defaults to false.
signature_idstringoptionalID of the signature to attach to this message. Only supported for email channels; using it on other channel types returns a 403 error.
subjectstringoptionalSubject of the message, for email messages.
tag_idsarrayoptionalList of tag IDs to add to the resulting conversation.
textstringoptionalText version of the body, for email messages.
toarrayoptionalList of recipient handles (e.g. email addresses) who will receive this message. At least one of to, cc, or bcc is required.
tool_versionstringoptionalTool version
front_update_contact#Update an existing contact's details by its Front contact ID.8 params

Update an existing contact's details by its Front contact ID.

NameTypeRequiredDescription
contact_idstringrequiredThe contact ID. Alternatively, you can supply the contact's source and handle as a resource alias.
custom_fieldsobjectoptionalCustom fields for this contact, keyed by the custom field name defined in the Front UI. Omit to leave existing custom fields unchanged; include all custom fields you want to keep when updating any of them.
descriptionstringoptionalContact description.
linksarrayoptionalList of links associated with the contact.
list_namesarrayoptionalList of contact list names the contact belongs to. Missing lists will be created automatically.
namestringoptionalContact name.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_update_conversation#Update a conversation's assignee, inbox, status, tags, task description, or due date. Required scope: conversations:write.11 params

Update a conversation's assignee, inbox, status, tags, task description, or due date. Required scope: conversations:write.

NameTypeRequiredDescription
conversation_idstringrequiredThe conversation ID.
assignee_idstringoptionalID of the teammate to assign the conversation to. Set to null to unassign.
custom_fieldsobjectoptionalCustom fields for this conversation, sent as an object of key:value pairs. If you want to update custom fields, include all custom fields, not just the ones you want to change, or the others will be erased.
descriptionstringoptionalDescription of the task. Only allowed on task conversations. Set to null to clear.
due_atnumberoptionalUnix timestamp in seconds when the task is due. Must be in the future and within 50 years. Only allowed on task conversations. Set to null to clear.
inbox_idstringoptionalID of the inbox to move the conversation to.
schema_versionstringoptionalSchema version
statusstringoptionalNew status of the conversation.
status_idstringoptionalUnique identifier of the status to set the conversation to. Only one of status and status_id should be provided. Ticketing must be enabled for the company to use this field.
tag_idsarrayoptionalList of all the tag IDs replacing the old conversation tags.
tool_versionstringoptionalTool version
front_update_conversation_assignee#Assign or unassign a conversation to a teammate. Required scope: conversations:write.4 params

Assign or unassign a conversation to a teammate. Required scope: conversations:write.

NameTypeRequiredDescription
assignee_idstringrequiredID of the teammate to assign the conversation to. Set to null to unassign.
conversation_idstringrequiredThe conversation ID.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_update_tag#Update an existing Front tag's name, description, highlight color, parent tag, or visibility. Only the fields provided are changed. Requires the tags:write scope.8 params

Update an existing Front tag's name, description, highlight color, parent tag, or visibility. Only the fields provided are changed. Requires the tags:write scope.

NameTypeRequiredDescription
tag_idstringrequiredThe unique Front identifier of the tag to update, e.g. 'tag_123'.
descriptionstringoptionalNew description of the tag's purpose.
highlightstringoptionalNew highlight color of the tag. One of: grey, pink, red, orange, yellow, green, light-blue, blue, purple.
is_visible_in_conversation_listsbooleanoptionalWhether the tag is visible in conversation lists.
namestringoptionalNew name for the tag. Maximum length is 64 characters.
parent_tag_idstringoptionalID of the parent tag to nest this tag under. Set to null to remove the parent tag.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
front_update_teammate#Update a teammate's username, name, or availability status in Front.7 params

Update a teammate's username, name, or availability status in Front.

NameTypeRequiredDescription
teammate_idstringrequiredThe teammate ID. Alternatively, you can supply an email as a resource alias.
first_namestringoptionalNew first name.
is_availablebooleanoptionalNew availability status.
last_namestringoptionalNew last name.
schema_versionstringoptionalSchema version
tool_versionstringoptionalTool version
usernamestringoptionalNew username. It must be unique and can only contain lowercase letters, numbers and underscores.