# freispace REST API

We offer a publicly accessible REST API to access your data on freispace.

## API documentation[​](#api-documentation "Direct link to API documentation")

Find the most recent API documentation here:

<https://api.freispace.com/docs>

## Authentication[​](#authentication "Direct link to Authentication")

The API uses *Bearer Tokens* for authentication. You can create a token in your team settings on the "Integrations" tab.

When sending requests to the API, you have to send the token in the `Authorization` header.

```
Authorization: Bearer <API key>
```

## Content Types[​](#content-types "Direct link to Content Types")

The REST API exclusively uses JSON (`application/json`) as content type.

## OpenAPI (Swagger) file[​](#openapi-swagger-file "Direct link to OpenAPI (Swagger) file")

Our **OpenAPI 3.0** JSON definition file can be found here:

<https://api.freispace.com/v1/definition>

## Rate Limiting / Throttling[​](#rate-limiting--throttling "Direct link to Rate Limiting / Throttling")

Rate limits specify the maximum number of requests (`GET`, `POST`, `PUT`, `PATCH` or `DELETE`) a user can make in a given time period. When you exceed a rate limit, the API request fails and returns the HTTP 429 status code. The HTTP 429 status code indicates that the user made too many requests in a given period of time ("rate limiting").

The API is throttled to **60 requests per minute per team**.

When reaching too many requests, the API will return a HTTP `429 Too Many Requests` status.

The following sample shows the API response for the status code 429.

```
HTTP/1.1 429 Too Many Requests

Date: Tue, 17 Oct 2023 12:29:21 GMT

X-Ratelimit-Limit: 60

X-Ratelimit-Remaining: 0

Retry-After: 60

X-Ratelimit-Reset: 1697545791
```