# Swarmia APIs

## Overview

Swarmia provides a rich set of APIs for integrators. You're able to both read the Swarmia data set through these APIs, and update data & configuration in Swarmia.

The APIs are organized into modules:

* [Built-in reports](/settings/integrations/swarmia-apis/built-in-reports.md) — Machine readable versions of all major reports you find in the app
* [Custom reports](/settings/integrations/swarmia-apis/custom-reports.md) — Custom reports specific to your organization, created in the app
* [Team management](/settings/integrations/swarmia-apis/team-management.md) — Programmatically update your teams and memberships
* [Time offs](/settings/integrations/swarmia-apis/time-off-api.md) — Create, read, update, and delete employee time off periods
* [Export API v0](/settings/integrations/swarmia-apis/export-api.md) — Legacy endpoints for querying built-in reports in the app

{% hint style="warning" %}
The Built-in reports & Custom reports API modules are currently in preview. Minor, mostly additive changes are still possible in the near future. Major changes will be carried out by publishing new versions of the endpoints.
{% endhint %}

## OpenAPI spec

Most Swarmia APIs also have a machine-readable specification available [here](https://app.swarmia.com/api/v1/openapi.json). It is automatically updated as new endpoints become available. You can learn more about the OpenAPI specification, including how to generate a Swarmia API client for your programming language of choice [here](https://swagger.io/specification/).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.swarmia.com/settings/integrations/swarmia-apis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.