API Documentation

Swift Payrolls API documentation

Swift Payrolls exposes a worker API for account access, subscription management, employee data, payslips, invoices, and reporting. This page provides the public discovery entry points for agents and developers.

Open API catalog View OpenAPI JSON

Authentication model

The public worker API currently uses Swift Payrolls application authentication rather than OAuth 2.0 or OpenID Connect discovery metadata.

Protected endpoints expect an application bearer token after login. The health endpoint and password reset initiation endpoints remain public.

Public Discovery

Endpoint	Purpose
API catalog	Machine-readable API discovery document.
OpenAPI	OpenAPI 3.1 description for representative endpoints.
GET /health	Worker health and availability check.

Authentication

Endpoint	Purpose
`POST /auth/signup`	Create an employer account.
`POST /auth/login`	Authenticate with email and password.
`POST /auth/google-login`	Authenticate with Google credentials.
`POST /auth/forgot-password`	Start password reset flow.
`POST /auth/reset-password`	Complete password reset flow.

Protected Employer API

Endpoint	Purpose
`GET /users/me`	Read the authenticated employer profile.
`GET /employees`	List employees in the employer workspace.
`POST /employees`	Create an employee record.
`GET /payslips`	List generated payslips.
`POST /payslips`	Create a payslip record.
`GET /invoices`	List invoice records.
`POST /invoices`	Create an invoice record.