> For the complete documentation index, see [llms.txt](https://help.steeple.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.steeple.com/en/administration/api-steeple.md).

# How do I use the Steeple API?

## Overview

The Steeple API lets your internal tools (HRIS, intranet, BI tool, etc.) exchange data with your Steeple organization, without going through the interface.

It is accessible at `https://api.steeple.com`. The complete reference of the endpoints, with their parameters and responses, is published on [https://api-docs.steeple.com](https://api-docs.steeple.com/).

## What the API allows

| Need                                    | Endpoints                                                                              | Access |
| --------------------------------------- | -------------------------------------------------------------------------------------- | ------ |
| Create, update, or remove collaborators | `POST /v1/blobs`, `POST /v1/member_provisionings`, `GET /v1/member_provisionings/{id}` | Write  |
| List the organization's collaborators   | `GET /v1/users`                                                                        | Read   |
| List the organization's communities     | `GET /v1/communities`                                                                  | Read   |
| List the posts                          | `GET /v1/posts`                                                                        | Read   |
| View a post's Statistics                | `GET /v1/posts/{id}/statistics`                                                        | Read   |

Writing only applies to collaborators, by file import: see [How do I synchronize my collaborator Directory with the Steeple API?](https://help.steeple.com/en/administration/synchroniser-annuaire-api.md).

The creation of posts or documents is not available via the API.

## Prerequisites

* Be an administrator of the organization.

## Step 1 — Generate a token

Go to the'**Administration**, section **Integrations** (`/administration/integrations`), then select **Steeple**.

Click **Generate a token** and fill in:

* **Last name** : the tool that will use the token, for example “HRIS”.
* **Description** : the intended use, so you can find it later.

The token is displayed **only once**. Copy it and store it safely before closing the window: it will no longer be possible to retrieve it. If lost, generate a new one and revoke the old one.

Create one token per tool: this way, you can cut off a tool's access without affecting the others.

## Step 2 — Call the API

Each request includes the token in the header `Authorization` :

```bash
curl "https://api.steeple.com/v1/communities" \
  -H "Authorization: Bearer <your token>"
```

A token gives access to the data of **the entire organization**. It does not correspond to any specific collaborator.

Lists are paginated with the parameters `page` (starting from 1) and `per_page` (20 by default, 50 maximum).

## Revoke a token

In **Integrations** > **Steeple**, click on **Revoke** next to the token. Calls made with this token are immediately rejected.

A token does not have an expiration date: it remains valid as long as it is not revoked. Treat it like a password and revoke it as soon as it may have been exposed.

## What the assistant can do

The assistant can guide the user to the page **Integrations** via navigate\_to and explain what the API allows (reading collaborators, communities and posts, importing collaborators). It cannot generate or revoke a token. For the details of the endpoints, direct to <https://api-docs.steeple.com>.
