- API access - Admin API access is available to merchants on our Superest, or custom plans. Contact the support team to request access.
- Authentication - Generate API keys from your Supercycle admin. See Authentication for details.
- Base URL - All API requests use the base URL:
https://app.supercycle.com/api/v1
API structure
The Admin API follows REST principles:- Resources are accessed via standard HTTP methods (GET, POST, PUT, DELETE)
- Requests and responses use JSON format
- Responses include standard HTTP status codes
- Pagination is available for list endpoints
Cycles
List, fetch, and update cycles at/cycles and /cycles/{cycleId}. These are the canonical paths.
The /rentals paths remain available as deprecated aliases with identical behavior. In API v1, request and response bodies still use the Rental schema and rental-named properties (rentalStart, rentalEnd, reallocateConflictingRentals, and so on). A schema rename is planned for API v2.
Rate limits
API requests are rate limited to ensure system stability. If you exceed the rate limit, you’ll receive a429 Too Many Requests response. Contact support if you need higher rate limits for your use case.