Introduction

You can use our API to request and update data on your Client Dashboard.

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.

• 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.