Authentication
The Core API uses Bearer tokens to authenticate its user.
You MUST send the token for each request in the Authorization header. The token MUST be preceded by Bearer. See the Authorization header in the example request below.
curl --request GET \
--url https://api2.frontapp.com/conversations/cnv_123/drafts
--header 'Authorization: Bearer [REQUEST_TOKEN]'OAuth v Front API Tokens
There are two ways to get a Bearer token — through API tokens in your settings or through an OAuth implementation.
In general, Front recommends implementing OAuth when feasible, which has the additional benefit of building within our application framework. The app framework makes it easy for customers to install your integration and makes it easy for you to update the integration with new Front features as they are added to the framework.
However, if you’re just building an integration for your own Front instance or a single Front customer, or just want to test our API endpoints as you brainstorm what to build, you can generate an API token to get up and running more quickly.
For Partners looking to launch a public integration to all Front customers, if your integration can support OAuth you’ll want to check out our OAuth guide. We require that public integrations use OAuth unless there is a reason they cannot. OAuth integrations are part of our application framework and can be easily installed by customers using the Front App Store, without requiring that customers manually configure an API token for your integration.
OAuth is required for public integrations available to all Front customers unless you obtain an exception from us. OAuth makes it much easier for customers to install your integration through our App Store.
Token scopes
Token scopes determine what resources the token (OAuth or API token) has access to edit. The following table explains the available scopes.
All tokens have access to global resources
Global resources are available to all tokens and include features like global tags and global rules.
Scope | Description |
|---|---|
Private resources | Access to private resources of individual team members, such as conversations, messages, inboxes, rules, and tags for an individual.
|
Shared resources | Access to workspace resources across all workspaces in your company. Workspace data includes all resources such as conversations, messages, inboxes, teammates, etc. that form part of a workspace. |
Workspace | Access to the resources of a particular workspace in your company. |
Knowledge Base | Access to knowledge base resources. |
Auto-provisioning | Access to Front's SCIM server, which is used to sync user accounts between Front and external systems. Available only on the Scale plan. |
Provisioning | Access to manage which workspaces, inboxes, and shifts a teammate is part of. |
Updated about 1 month ago