Salsa Onboarding & Sessions API

User tokens, hosted onboarding, and mock onboarding.

Operations 4

POST /user-tokens Create a scoped user API token (e.g. EMPLOYER_ADMIN) for the embeddable UI #
POST /employers/{employerId}/hosted-onboardings Create a hosted onboarding flow for an employer #
POST /employers/{employerId}/mock-onboard Simulate employer onboarding (sandbox only) #
POST /employers/{employerId}/workers/mock-onboard Simulate worker onboarding (sandbox only) #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/salsa-onboarding-sessions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

salsa-onboarding-sessions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Salsa Payroll Onboarding & Sessions API
  description: Representative OpenAPI description of the Salsa embedded payroll REST API.
  termsOfService: https://www.salsa.dev/legal
  contact:
    name: Salsa Support
    url: https://docs.salsa.dev/
  version: rest-v1
servers:
- url: https://api.salsa.dev/api/rest/v1
  description: Production (partner production API key)
- url: https://api.sandbox.salsa.dev/api/rest/v1
  description: Sandbox (partner sandbox API key)
security:
- bearerAuth: []
tags:
- name: Onboarding & Sessions
  description: User tokens, hosted onboarding, and mock onboarding.
paths:
  /user-tokens:
    post:
      operationId: createUserToken
      tags:
      - Onboarding & Sessions
      summary: Create a scoped user API token (e.g. EMPLOYER_ADMIN) for the embeddable UI
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserTokenCreate'
      responses:
        '201':
          description: A user token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserToken'
  /employers/{employerId}/hosted-onboardings:
    parameters:
    - $ref: '#/components/parameters/EmployerId'
    post:
      operationId: createHostedEmployerOnboarding
      tags:
      - Onboarding & Sessions
      summary: Create a hosted onboarding flow for an employer
      responses:
        '201':
          description: Hosted onboarding created.
  /employers/{employerId}/mock-onboard:
    parameters:
    - $ref: '#/components/parameters/EmployerId'
    post:
      operationId: mockOnboardEmployer
      tags:
      - Onboarding & Sessions
      summary: Simulate employer onboarding (sandbox only)
      responses:
        '200':
          description: Employer mock-onboarded.
  /employers/{employerId}/workers/mock-onboard:
    parameters:
    - $ref: '#/components/parameters/EmployerId'
    post:
      operationId: mockOnboardWorker
      tags:
      - Onboarding & Sessions
      summary: Simulate worker onboarding (sandbox only)
      responses:
        '200':
          description: Worker mock-onboarded.
components:
  parameters:
    EmployerId:
      name: employerId
      in: path
      required: true
      description: The employer (company) identifier.
      schema:
        type: string
  schemas:
    UserToken:
      type: object
      properties:
        token:
          type: string
        role:
          type: string
        expiresAt:
          type: string
          format: date-time
    UserTokenCreate:
      type: object
      required:
      - employerId
      - role
      properties:
        employerId:
          type: string
        role:
          type: string
          enum:
          - EMPLOYER_ADMIN
          - WORKER
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Partner Bearer API key. Approved Salsa platform partners receive separate sandbox and production keys. Send as `Authorization: Bearer ${YOUR_API_TOKEN}`.'