Reference Overview

The source of truth for Salsa’s API, embeddable UI experiences, and web SDK - plus OpenAPI spec downloads.

👍

Quick links

OpenAPI (latest): From the OpenAPI specs page download the REST API - v1 spec.

The Reference section contains the exact specifications you use to build against Salsa: endpoint definitions, event contracts, and SDK APIs. If you’re looking for concepts, walkthroughs, or best‑practices, head to Documentation instead.

What’s in Reference

  • REST API - Authoritative definitions of all endpoints and webhooks (the spec above powers codegen and tooling).
  • UI Experiences - Embeddable, production‑ready Employer and Worker flows with documented events and parameters.
  • Salsa.js (Web SDK) - Client‑side library for loading, configuring, and interacting with Salsa UI components.

Environments & Authentication

Use the appropriate base URL and authenticate per your account’s setup.

  • Sandbox: https://api.sandbox.salsa.dev
  • Production: https://api.salsa.dev

See the Authorization guide for token types, scopes, and examples. Rate‑limit behavior and headers are documented in API rate limits.

Using the OpenAPI spec

You can import the spec into your preferred tools to generate clients, validate requests/responses, or explore endpoints locally.

  • OpenAPI Generator (example):
    OpenAPI Generator is one such generator that supports producing SDK client for many languages. Simplify obtain the URL that links to the specific version that you want to use from the OpenAPI spec page and specify your target language/framework. Doing so to create and SDK in TypeScript using axios could be done like this:
    npx @openapitools/openapi-generator-cli generate \
      -i https://docs.salsa.dev/openapi/the_url_you_obtained \
      -g typescript-axios \
      -o ./generated/salsa
  • Postman / Insomnia: Import the YAML or JSON file directly to create a workspace with request templates.

Versioning: The OpenAPI spec page will have links for each available version of the API, e.g., REST API - v1, which will always point to the latest public spec file for that version.

Pick your path

  • Embed the UI: Start with UI Experiences and Salsa.js to add prebuilt employer/worker flows with minimal backend work.
  • Build via API: Start with the REST API. Use the OpenAPI file above for code generation and then follow the endpoint docs in the left nav.

Support

Have questions about scopes, webhooks, or rollout timelines? Reach out through your Salsa contact or support channel and we’ll help you get unblocked.