> For the complete documentation index, see [llms.txt](https://docs.clients.icaal.co.uk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.clients.icaal.co.uk/master.md).

# Introduction

## Endpoints

Our endpoints can be reached at `https://api.clients.icaal.co.uk` using the following HTTP methods:

* `GET`
* `POST`
* `PATCH`
* `DELETE`

## Responses

All responses will be formatted as JSON with one of the following codes:

* `200` - OK
* `401` - Authentication failed
* `403` - Endpoint not authorised
* `422` - Validation errors occurred
* `429` - Too many requests - see [rate limiting](/master.md#rate-limiting).
* `500` - Server error

## Rate Limiting

The API is limited to 60 requests per minute. You can see how many requests you have left by using the `X-RateLimit-Remaining` header.

If this exceeded you will receive a `429` response code. The API will send a `Retry-After` header that tells you the number of seconds to wait before trying again.