All URLs referenced in this documentation have the following base URL:
The Siteimprove REST API is served over HTTPS for improved data privacy. HTTP is not supported.
Three endpoints will assist you in exploring the API:
- Documentation for the API is at https://api.siteimprove.com/v2/documentation
- The API itself is at https://api.siteimprove.com/v2
- OpenAPI Spec for the API is at https://api.siteimprove.com/v2/documentation/openapi_spec
The API itself provides HAL-style navigation links to explore the full API.
The documentation contains description of all endpoints, parameters, and returned values. It also offers the ability to try out all the endpoints.
The OpenAPI spec (formerly Swagger) is a formal definition of the API, suitable for use in e.g. code generation.
You must authenticate with your account credentials in order to access any part of the API, including the links above.