👉 API access is included with the Scale and Enterprise plans. Find out more!
Our APIs are based on a RESTful approach (see REST). It features predictable and resource-oriented URLs and uses HTTP response codes to indicate API errors. Our REST APIs consist of HTTP methods that you can use to build integrations that don't rely on interactions in the Holaspirit interface.
Why you should use our REST APIs?
To connect Holaspirit to a third-party product
To enable flows that require communicating with a server backend or a database
Holaspirit's API documentation
🔗 Access all resources relating to our API
https://app.holaspirit.com/api/doc/
🔗 Check Holaspirit developers' API guide: a reference manual with all the information you need to get started
https://github.com/holaSpirit/holaspirit-docs/blob/master/api.md
🔗 Consult our API endpoints doc to get details on all endpoints
🔗 Subscribe to our Changelog to stay on top of all API changes
https://github.com/holaSpirit/holaspirit-docs/blob/master/changelog.md
How to get notified of API changes?
To get notifications (email and Github) for changes we make to our API, you can subscribe to our changelog:
Go to our API documentation page
Click on the Watch button
Select All activity
Obtain your API token
👤 Only Admins can create an API token.
To generate an API token:
Go to Administration settings
Find the API tab
Click on Generate token
Enter your token's name
Click on Create
Your API token is ready to be copied and used to connect with a third-party product.
After you get a read-only access token, you can use it for all your GET requests, it never expires.
Parameters
client_id: Required OAuth2 Client ID
client_secret: OAuth2 Client secret
grant_type: OAuth2 grant
type: "password" or "refresh_token"
username: Email
password: Password
timezone: Timezone (e.g.: "+02:00")
The client secret is not required for a public app.
The default and public Client ID is: 54cb79d0279871e1248b4567_400tdzqbdcowsskk08gws0wkwogck00w084w4s8w8gok08s0o8.
Response
{
"access_token": "#################",
"expires_in": 3600,
"token_type": "bearer",
"scope": null,
"refresh_token": "#################"
}
Response errors
Incorrect Client ID (status code: 400):
{
"error": "invalid_client",
"error_description": "The client credentials are invalid"
}
Incorrect credentials (status code: 400):
{
"error": "invalid_grant",
"error_description": "Invalid username and password combination"
}
Endpoints
Once authenticated, you can use all endpoints listed in the documentation:
Basic usage (to get the roles of your organization):
curl 'https://app.holaspirit.com/api/stats/organizations/******/roles' -H 'Authorization: Bearer *****'