REST API Reference for the Rillsoft Integration Server

REST API Reference

The API reference is generated from the OpenAPI specification (openapi.json) of the Rillsoft Integration Server. It is split by version: v1 is the REST layer originally built for the Rillsoft Android app, v2 is the full REST generation introduced with Rillsoft Project 10.

Versions at a glance

API v1 – built for the Rillsoft Android app

API v1 is the first REST step of the Rillsoft Integration Server: built specifically as the backend for the Rillsoft Android app, alongside the SOAP web service that existed at the time. Its scope reflects what the mobile app needs – login, clients, DMS downloads, vacation management, timesheets, and dashboard data.

The version remains documented for customers running the Android app or maintaining earlier integrations that have not yet moved to v2.

→ Endpoints, schemas, and standard responses for API v1

API v2 – the REST generation with Rillsoft Project 10

With Rillsoft Project 10, the entire integration layer moved from the SOAP web service to REST. API v2 is the result: fully JSON, versioned in the URL (/api/v2/...), Bearer-token authentication, and a complete OpenAPI description. The surface keeps expanding – DMS, projects, resources, workload, vacation management, and dashboards.

→ Endpoints, schemas, and standard responses for API v2

How to read this reference

• Endpoint pages show method, path, parameters, request body, response codes, and example responses.
• Schemas describe the JSON data structures used in requests and responses.
• Standard responses (error-responses) collect reusable error formats from components.responses.
• Path parameters lists the shared path parameters from components.parameters.

Which version should I choose?

For any new project, API v2 is the right choice. v1 is kept solely to support existing integrations and does not receive new functional endpoints.