Partner API reference

Every endpoint a customer's integration key reaches, grouped by resource, with parameters, fields and example requests and responses.

Every partner endpoint is a GET under https://api-integrations-next.vitruve.fit/v1, called with the customer's key in X-API-Key and your secret in X-Partner-Secret, from a registered address. Lists are paginated and share the filtering conventions.

Any other path answers 404 Route not found, and any other method 405 Method not allowed. If your integration needs data that is not listed here, such as programs, templates or load-velocity profiles, write to support@vitruve.fit.

Reading an endpoint

Each endpoint shows its description and parameters on the left. On the right, a request you can copy in cURL, JavaScript or Python (your language choice is remembered), with both partner headers, and the response you will get. Lists show a trimmed example: real responses hold up to limit items.

Responses use the shared envelope. Failures are listed in Error codes.

On this page