> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mitwirken.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Understand general concepts, response codes, and authentication strategies.

## Base URL

The Mitwirken API is built on REST principles. We enforce HTTPS in every request to improve data security, integrity, and privacy. The API does not support HTTP.

All requests contain the following base URL:

```
https://api.mitwirken.me
```

## Authentication

To authenticate you need to add an Authorization header with the contents of the header being `Bearer mit_123456789` where `mit_123456789` is your [API Key](https://app.mitwirken.me/api-keys).

```
Authorization: Bearer mit_123456789
```

## Response codes

Mitwirken uses standard HTTP codes to indicate the success or failure of your requests.

In general, `2xx` HTTP codes correspond to success, `4xx` codes are for user-related failures, and `5xx` codes are for infrastructure issues.

| Status | Description                                |
| ------ | ------------------------------------------ |
| 200    | Successful request.                        |
| 400    | Check that the parameters were correct.    |
| 401    | The API key used was missing.              |
| 403    | The API key used was invalid.              |
| 404    | The resource was not found.                |
| 429    | The rate limit was exceeded.               |
| 5xx    | Indicates an error with Mitwirken servers. |

<Note>
  Check [Error Codes](/api-reference/error-codes) for a comprehensive breakdown of all possible API errors.
</Note>

## Rate limit

The response headers describe your current rate limit following every request in conformance with the [IETF standard](https://datatracker.ietf.org/doc/html/draft-ietf-httpapi-ratelimit-headers):

| Status              | Description                                                         |
| ------------------- | ------------------------------------------------------------------- |
| Header name         | Description                                                         |
| ratelimit-limit     | Maximum number of requests allowed within a window.                 |
| ratelimit-remaining | How many requests you have left within the current window.          |
| ratelimit-reset     | How many seconds until the limits are reset.                        |
| retry-after         | How many seconds you should wait before making a follow-up request. |
| 429                 | The rate limit was exceeded.                                        |
| 5xx                 | Indicates an error with Mitwirken servers.                          |

The default maximum rate limit is **2 requests per second**. This number can be increased for trusted senders by request.

After that, you’ll hit the rate limit and receive a `429` response error code.

To prevent this, we recommend reducing the rate at which you request the API. This can be done by introducing a queue mechanism or reducing the number of concurrent requests per second. If you have specific requirements, [contact support](mailto:support@mitwirken.me) to request a rate increase.

​

## FAQ

<AccordionGroup>
  <Accordion title="How does pagination work with the API?">
    We do not support pagination yet.
  </Accordion>

  <Accordion title="How do you handle API versioning?">
    We do not support API versioning yet.
  </Accordion>
</AccordionGroup>