API reference
Reading Steps provides API endpoints for integrating with external systems and building custom solutions.
Authentication
API requests require a Link Token for authentication. This token is unique to your organization and can be found in the admin panel.
Getting your Link Token
- Log in to the admin panel
- Go to Integrations
- Click the eye icon to reveal your token
- Enter your password to confirm your identity
Keep your Link Token secure. Anyone with this token can access your organization’s data. If you suspect it has been compromised, regenerate it immediately.
Regenerating your token
If you need to invalidate your current token:
- Go to Integrations in the admin panel
- Reveal your current token
- Click the refresh icon to generate a new token
- Update all external services with the new token
Using your token
Include your Link Token in the Authorization header of all API requests:
curl -X GET "https://app.readingsteps.uk/api/version" \
-H "Authorization: Bearer YOUR_LINK_TOKEN"
Available endpoints
Version endpoint
Check the current Reading Steps UI version.
Response:
{
"readingstepsUI": "v1.0.6"
}
ReadingstepsUI endpoint
Get the current UI configuration.
Response:
{
"readingstepsUI": "v1.0.6"
}
Rate limits
API requests are rate-limited to ensure platform stability:
| Endpoint | Limit |
|---|
| General API | 100 requests/minute |
| Import operations | 10 requests/hour |
Error handling
The API returns standard HTTP status codes:
| Status Code | Description |
|---|
| 200 | Success |
| 400 | Bad request - check your parameters |
| 401 | Unauthorized - invalid or missing token |
| 403 | Forbidden - token doesn’t have access |
| 404 | Not found - endpoint or resource doesn’t exist |
| 429 | Too many requests - rate limit exceeded |
| 500 | Server error - contact support |
{
"error": "Unauthorized",
"message": "Invalid or expired Link Token",
"code": 401
}
Support
For API support or to request new endpoints:
