Skip to content

Overview ​

Beta

Salaxy API v04 is in beta: it may change, and it is not used in production yet. Build on v03, the current version.

Mainly read-only methods over all objects owned by the current account.

Salaxy API v04 (beta), Finland only. 2 operations. Interactive version: REST API reference. Machine-readable: OpenAPI document.

The reference wins

These pages are generated from the OpenAPI document. If a guide and this reference disagree about a field, follow the reference. Error responses are not in the document — see Errors.

GET /v04/api/overview/all ​

Makes an OData query over all objects within the current account.

ParameterInTypeRequiredDescription
$searchquerystring
$filterquerystringSpecifies the logic to pull back a subset of records.
$orderbyquerystringSpecifies the values used to sort the collection of entries.
$selectquerystringThe $select system query option allows the clients to requests a limited set of properties for each entry.
$topquerynumberSpecifies the subset of entries by count.
$skipquerynumberSpecifies the count of entries to skip.
$countquerybooleanIndicates whether or not to include a total entry count.

Response: PageResultOfApiListItem

Try it: interactive reference

GET /v04/api/overview/welcome-worker ​

Gets the data that is used by the welcome screen of the Worker account for the current account. Currently, all personal accounts are interpreted as Workers - regardless of whether they have paid salaries in Household role.

Response: WelcomeDataWorker

Try it: interactive reference

Every page is also available as Markdown: add .md to its URL — a folder page such as white-label/ is white-label/index.md. Index for LLMs: llms.txt. Questions: Support.