PLEASE NOTE - The API and this documentation are both not officially supported yet! These are pre-release features and changes will happen. No guarantees.
All the data you see in the Firmhouse dashboard and reports, are also accessible via our API.
The structure of this API is based on GraphQL; data can be retrieved using HTTP/web based requests. One of the main features of GraphQL is the ability to define the information and structure of the returned data within the request. The requests are normal, authenticated POST HTTP requests.
For full API documentation, visit our developer page https://developer.firmhouse.com/graphql
Endpoint authentication
The Firmhouse API has a public endpoint: https://portal.firmhouse.com/graphql.
Requests to the API authenticate using the header: "X-PROJECT-ACCESS-TOKEN".
This token can be found in your project under the "Integrations" settings page. Only users with the "Project Manager" role are able to view and manage this token. If a token hasn't been generated yet for the project, contact your administrator.
Make sure that you make request with a "Content-Type: application/json" header.
Retrieve Subscriptions and Orders
With an authenticated call, the GraphQL API can return details on your projects subscriptions and orders.
Example calls
To retrieve a list of subscriptions:
{
getSubscriptions(limit: 100) {
id
name
lastName
fullName
activatedAt
signupCompletedAt
activePlan {
name
slug
}
extraFields {
name
value
}
}
}returns a list that looks like this json response:
{
"data": {
"getSubscriptions": [
{
"id": "12345",
"name": "Jim Example",
"lastName": "Example",
"fullName": "Jim Example",
...
...
}
Get a list of confirmed orders
{
getOrders {
id
status
subscription {
id
name
lastName
address
houseNumber
zipcode
city
state
country
email
phoneNumber
extraFields {
name
value
}
activePlan {
name
}
}
}
}Third Party Integrations
For instructions on how to integrate with your Qlikview dashboard, see the Qlik documentation:
Select and load data from a REST data source ‒ Qlik Connectors