FreshBooks

Search

FAQs

Support Rockstars
at Your Service!

What is my authentication token and where can I get it?

What do I need to enable third party add-ons?

FreshBooks connects to a wide array of tools and services. You can find the list from http://community.freshbooks.com/addons/

Each add-on has different specific requirements, but they all require two pieces of information:

  • Either your Account URL, which is the same as your login page URL, or your API URL.
  • Your Authentication Token.

See below for how to get these pieces of information.

What is my Account URL?

If you are asked for your account URL, it is the same thing as your login page URL. Depending on your setup, it will look either like https://joesgarage.freshbooks.com or
https://joesgarage.billingarm.com. If you don’t know what your login page URL is, you can search for it with your email address.

What is my API URL?

Your API URL is the location on the Web where the add-on talks to your FreshBooks account. You probably don’t need to know anything about it except where to find it so you can copy and paste it into the add-on. Instructions to retrieve it are below.

What is my Authentication Token?

Your Authentication Token is a verification code that allows third-party software and services to update and retrieve your account data. Your Authentication Token should be kept secret and only entered into software and services that you trust. Instructions to retrieve it are below.

I’m an administrator: where do I get my API URL and Authentication Token?

  1. Click on your white “My Account” link in the top right corner.
  2. Click on your “FreshBooks API” sub-tab on the top right.
  3. Click on your blue “terms of service” to review the terms of service.
  4. Click on your checkbox next to “Yes, I agree to the API terms of service” to agree to the terms of service.
  5. Your “API URL” and “Authentication Token” will become visible on your screen.

I’m a staff member: how do I retrieve my API URL and Authentication Token?

  1. Ask your administrator to agree to the API terms of service, mentioned above.
  2. Click on your white “Profile” link in the top right corner.
  3. Your “API URL” and “Authentication Token” will be visible at the bottom of the screen.

What do I do if my Authentication Token becomes compromised?

Your Authentication Token is linked to your account password. Just change or reset your account password and your API key will also change. You will have to provide the new Authentication Token to all the add-ons you continue to use.

If you are an administrator, you can also disable all add-ons by following the same steps above but choosing to uncheck the checkbox next to “Yes, I agree to the API terms of service”.