> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.holaspirit.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Holaspirit API documentation

Our APIs are based on a RESTful approach (see [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)). 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.

👉 API access is included with the [Scale](https://help.holaspirit.com/en/article/how-does-holaspirits-scale-plan-work-4verrd/) and [Enterprise](https://help.holaspirit.com/en/article/how-does-holaspirits-enterprise-plan-work-18m5r50/) plans.

**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/](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](https://github.com/holaSpirit/holaspirit-docs/blob/master/api.md)

🔗 Consult our **API endpoints doc** to get details on all endpoints

[https://app.holaspirit.com/api/doc/](https://app.holaspirit.com/api/doc/)

🔗 Subscribe to our **Changelog** to stay on top of all API changes  
[https://github.com/holaSpirit/holaspirit-docs/blob/master/changelog.md](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](https://help.holaspirit.com/en/article/holaspirit-api-documentation-1q9vj14/)
* Click on the **Watch** button
* Select **All activity**

[![](https://storage.crisp.chat/users/helpdesk/website/-/e/e/8/a/ee8aff8aa1491800/a5746fc8-aeed-43f5-be1e-c6ce68_gz0o2.png)](https://downloads.intercomcdn.com/i/o/828331158/5f0798504db6f1af20145085/Screenshot+2023-09-12+at+10.25.57.png?expires=1742568300&signature=a0133079390bbf047c530ee556195094c579b8bb405cb268747882aae24c9a63&req=fCIvFcp%2FnIRXFb4f3HP0gH0faR6BGVryZRxaALwNswdYLwEb98tsR4YKS3dw%0AQRRTebye70Kdj0SpUg%3D%3D%0A)
---

# 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**

![](https://storage.crisp.chat/users/helpdesk/website/-/c/4/1/5/c415f7c7930b8000/screenshot-2025-06-18-at-11005_zgmrlg.png)

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.

👉 [More about managing API tokens as an Admin](https://help.holaspirit.com/en/article/manage-api-tokens-as-an-admin-ex23hu/)
---

# 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 *****'
```