What is FreshBooks' API and how can I connect to it?

An API, also known as application programming interface, is the building blocks developers use to create software and applications. APIs allow the linking of information between one source and another and the automation of tasks between them. You can use FreshBooks' API to automate different parts of your FreshBooks account or to create integrations with your favourite apps.

If you're a developer/programmer interested in building an app with your account, FreshBooks' API makes it easy to create these apps through OAuth2 for authentication. For inspiration, check out our AppStore for our available apps anytime.

 

API and Webhook Resources

Use the below to access our current API documentation anytime: 

 

API Help

Our API Support team is available to help, including any API calls that involve FreshBooks endpoints as well as:

  • Thinking through workflows
  • Identifying errors that you might be receiving
  • Understanding responses

Most of the examples in the API documentation use cURL, but if needed, you can use FreshBooks’ Postman Documentation to view all the documented calls in many different languages and formats.

 

API-related questions can be sent to our API Support team. When reaching out, include the following with your request: 

  • What went wrong, including any error codes or responses you’ve received
  • What you’re aiming to accomplish
  • What work you’ve done so far, including the API call (with headers), and the account_id or business_id you’re working with

 

Create a FreshBooks App

To create an app with your FreshBooks account, follow these steps: 

  1. Create a new FreshBooks account, or if you already have an existing new FreshBooks account, log into it
  2. Go to the Developer hub
  3. Then select Apps
  4. Select the Create New App button
    Developer account with create new app button available.
  5. Enter in the Application Name
    Create application with fields to fill out for an app.
  6. Next, choose the Application Type
  7. Then enter a Description, Website URL, and Application Settings URL
  8. If needed, select the Add Scope button and choose from the list of available scopes
  9. Next, enter the Redirect URIs
  10. If needed, select the Upload Logo in the top corner and select a .JPG or .PNG image file
  11. Then select the Save button to submit your application. You can continue using your FreshBooks account as your sandbox or testing environment so you can build your FreshBooks app using the API.

 

Developer Hub

Access your Developer hub anytime at the Developer hub link. Select Apps to manage your applications or to submit a new application anytime.