The following tools and resources help you develop integrations using the Core API.

OpenAPI spec

You can view the Core API spec file on GitHub.

Some of the benefits of using the OpenAPI spec include:

  • Inspecting the API.
  • Using a code generator to generate stub code for the API in the programming language of your choice.
  • Building mock servers.

Postman collection

Postman is an HTTP client for testing web services. Postman makes it easy to test APIs by allowing users to quickly put together both simple and complex HTTP requests. If you are not familiar with Postman, refer to their online documentation and tutorials.

To expedite development, Front provides the Core API Postman collection in our Postman public workspace.

Run in PostmanRun in Postman

  1. Click the button above to fork the collection available in our public workspace and begin testing our API through Postman.
    Note: You can also view our public Postman workspace before forking it.
  2. After you fork the collection, click the top-level Core API collection in Postman. You should see the Authorization tab appear.
  3. In the Authorization tab, set Type to Bearer Token.
  4. In the Authorization tab, set Token to your unique token value. Read our Authentication guide to learn how to obtain a token.
  5. Create a new environment in Postman.
  6. Add a global variable named baseUrl to the environment and set its value to https://api2.frontapp.com
  7. Save the environment and then return to the Core API Postman collection.
  8. Select the environment you created from the Environments dropdown menu. With your authentication details specified and the baseUrl variable defined, you should now be able to test the requests in the Core API collection.

👍

The Postman collection automatically updates when we make changes to the Core API

When we make updates to our API, Postman notifies you and allows you to pull the changes from the Postman collection into your fork.

If you don't receive a notification, you can select the Pull changes option within your forked collection to pull the latest updates manually.


Did this page help you?