Table of Contents
Organize, collaborate, and manage email, social, chat, and SMS in your shared inbox with your team. Connect 50+ apps to your inbox. Get more work done in one place.
API Overview
Front is a cloud-based customer communication platform that empowers teams to collaborate efficiently and provide exceptional customer experiences. It centralizes all communication channels, including email, SMS, social media, and live chat, into a unified inbox. Front's intuitive interface and powerful features enable teams to streamline workflows, automate tasks, and track customer interactions seamlessly. With its robust integrations and developer-friendly API, Front seamlessly connects with other business tools and allows for customization to meet specific business needs.
Front's API provides a comprehensive set of RESTful endpoints that enable developers to integrate Front with their applications and automate various tasks. The API documentation is meticulously crafted, providing clear and detailed instructions on how to use each endpoint. Developers can leverage the API to perform actions such as sending and receiving emails, managing contacts, creating and updating conversations, and accessing analytics. Front also supports webhooks, allowing developers to receive real-time notifications for specific events, such as new messages or updates to conversations. To ensure optimal performance and prevent abuse, Front implements rate limits to regulate the number of API requests per second.
API Request Limits
Free
100 requests per minute
Growth
500 requests per minute
Scale
1000 requests per minute
Enterprise
Custom rate limits
SDKs
APIs
Method: GET
Description: Retrieves a list of comments for a given conversation..
Endpoint: /conversations/:conversation_id/comments
Parameters: conversation_id
Method: GET
Description: Retrieves a list of conversations..
Endpoint: /conversations
Parameters: query, page, per_page, sort_direction, sort_field, status, team_id, updated_since
Method: POST
Description: Creates a new conversation..
Endpoint: /conversations
Parameters: body (json), inbox_id, message
Method: GET
Description: Retrieves a single conversation..
Endpoint: /conversations/:conversation_id
Parameters: conversation_id
Method: GET
Description: Retrieves a list of contacts..
Endpoint: /contacts
Parameters: page, per_page, query, sort_direction, sort_field, updated_since
Method: POST
Description: Creates a new contact..
Endpoint: /contacts
Parameters: body (json)
Method: GET
Description: Retrieves a single contact..
Endpoint: /contacts/:contact_id
Parameters: contact_id
Method: GET
Description: Retrieves a list of inboxes..
Endpoint: /inboxes
Parameters: page, per_page, sort_direction, sort_field, team_id
Method: POST
Description: Creates a new inbox..
Endpoint: /inboxes
Parameters: body (json)
Method: GET
Description: Retrieves a single inbox..
Endpoint: /inboxes/:inbox_id
Parameters: inbox_id
Method: GET
Description: Retrieves a list of messages for a given conversation..
Endpoint: /conversations/:conversation_id/messages
Parameters: conversation_id, page, per_page, sort_direction, sort_field
Method: POST
Description: Creates a new message in a given conversation..
Endpoint: /conversations/:conversation_id/messages
Parameters: body (json), conversation_id
Method: GET
Description: Retrieves a single message..
Endpoint: /messages/:message_id
Parameters: message_id
Method: GET
Description: Retrieves a list of notes for a given conversation..
Endpoint: /conversations/:conversation_id/notes
Parameters: conversation_id, page, per_page, sort_direction, sort_field, updated_since
Method: POST
Description: Creates a new note for a given conversation..
Endpoint: /conversations/:conversation_id/notes
Parameters: body (json), conversation_id
Method: GET
Description: Retrieves a single note..
Endpoint: /notes/:note_id
Parameters: note_id
Method: GET
Description: Retrieves a list of teams..
Endpoint: /teams
Parameters: page, per_page, sort_direction, sort_field
Method: POST
Description: Creates a new team..
Endpoint: /teams
Parameters: body (json)
Method: GET
Description: Retrieves a single team..
Endpoint: /teams/:team_id
Parameters: team_id
Method: GET
Description: Retrieves a list of users..
Endpoint: /users
Parameters: page, per_page, sort_direction, sort_field, team_id
Method: POST
Description: Creates a new user..
Endpoint: /users
Parameters: body (json)
FAQ
How do I authenticate to the Front API?
You can authenticate using an API token. Create a token in your Front account settings and use it in the Authorization header of your API requests.
What are the rate limits for the Front API?
The Front API has a rate limit of 100 requests per minute per user. If you exceed this limit, your requests will be throttled.
Can I create a sandbox account for testing?
Yes, you can create a sandbox account by contacting Front support. Sandbox accounts are isolated from production data and can be used for testing and development.
How do I create a developer account?
To create a developer account, you need to sign up for a Front account and then apply for developer access through the Front API documentation.
What is the difference between a personal access token and a service account token?
A personal access token is used to authenticate a single user, while a service account token is used to authenticate a service or application. Service account tokens have a limited lifespan and can be revoked at any time.