Documentation

Use the Firmhouse API to add and automate subscription capabilities into your business. For example, take a look at the following use cases to get an idea of what you an do with the API:

API use cases

  • Initiate a new customer sign up and payment flow for your products and plans.
  • Fetch information about your (active) customers for loading into other systems (CRM, email marketing tooling) or business analytics tooling
  • Update a customer's active plan or active products so that you can upgrade or downgrade their active subscription.
  • Fetch orders generated by Firmhouse to load them into your warehouse, ERP, or logistics processes.
  • Update a customer's personal details, for example from your own "my account" portal in your website/app or CRM.

Alternative integration options

Our API is perfect for deep integration into your current website or existing IT systems and processes if you have development power available.

However, if you're looking to automate certain processes based on common events - like a new customer signing up - you can also use our out-of-the-box integrations with common tools like Google Sheets and Zapier. To learn more about all ready-made integration options, take a look at the automation & extensibility page.

GraphQL API

Our API is built on GraphQL. If you're already familiar with GraphQL, you'll know it's an excellent technique to build modern web applications against. GraphQL is especially useful for easily getting primary and it's related data out of our platform, without the need for a lot of individual API requests.

If you have no experience with GraphQL yet then fear not. GraphQL has excellent API library support for all major programming languages across the globe. And in it's essence, it is not so much different than using other modern API techniques, like REST. You can just send HTTP requests to our API endpoint to fetch data or to update data or trigger certain processes on our end. All requests return JSON-formatted results.

To take a look at some quick samples on how to talk to a GraphQL API, take a look at the following two guides in these developer docs:

Because a GraphQL is automatically "self documenting", you can also browse and query our API in a tool like GraphiQL. Check out the API Reference page for more details.

API Connection information

Main API endpoint: https://portal.firmhouse.com/graphql

Use the X-PROJECT-ACCESS-TOKEN header for authentication.