Overview

The Worx Safety API allows you to programmatically access and manage your safety management data. Use the API to integrate Worx Safety with your existing business systems, build custom reporting dashboards, automate data synchronisation, or create custom workflows.

Base URL: https://app.worxsafety.com.au

Full API Documentation: https://app.worxsafety.com.au/docs

Who Should Use the API?

The Worx Safety API is designed for:

• Developers building custom integrations with your business systems
• IT teams synchronising data between Worx Safety and HR, payroll, or job management software
• Companies with specific reporting requirements that go beyond standard exports
• Partners and resellers building solutions on top of Worx Safety

If you're looking for no-code integrations, consider using our Zapier integration instead.

Getting Started

Step 1: Generate Your API Token

To access the API, you'll need to generate an API token from your Worx Safety dashboard.

1. Log in to your Worx Safety account at app.worxsafety.com.au
2. Navigate to Integrations > API Tokens
3. Click Create Token
4. Give your token a descriptive name (e.g., "HR System Integration")
5. Select the required abilities/permissions for your integration
6. Copy your token and store it securely — you won't be able to view it again

Note: Only company administrators can generate API tokens.

Step 2: Authenticate Your Requests

All API requests require authentication using a Bearer token. Include your API token in the Authorization header of every request:

Authorization: Bearer {YOUR_API_TOKEN}

Step 3: Test Your Connection

Use the test endpoints to verify your integration is working correctly before building your full solution.

Available Resources

The API provides access to the following resources:

API Token Permissions

When generating an API token, you can select specific abilities that control which endpoints the token can access. Common permissions include:

• user-read — Read inductee/worker data
• user-create — Create new inductees
• user-update — Update existing inductees
• asset-read — Read asset data
• asset-create — Create new assets
• sites-read — Read project/site data
• documents-read — Read document data

Only grant the permissions your integration requires to maintain security.

Common Use Cases

Sync Employee Data from HR Systems

Use the Inductees endpoints to automatically create worker records when new employees are added to your HR system, and disable records when employees leave.

POST /api/inductee/create
PUT /api/inductee/update/{id}
PUT /api/inductee/disable/{id}

Build Compliance Dashboards

Pull document expiry data to create custom compliance dashboards showing upcoming licence and insurance renewals.

GET /api/documents/index/expiring
GET /api/documents/index/expired

Integrate with Job Management Software

Automatically create projects in Worx Safety when new jobs are created in systems like Simpro, ServiceM8, or your custom software.

POST /api/project/create
GET /api/project/index

Monitor Site Activity

Track who is on site by querying project events data.

GET /api/project_events/all
GET /api/project_events/show/{id}

Asset Management Integration

Sync your fleet or equipment data with asset management or accounting systems.

GET /api/asset/index
POST /api/asset/create
GET /api/asset/maintenance/{id}

Testing the API

We provide tools to help you test the API before building your integration:

Postman Collection Download our pre-built Postman collection to test API endpoints interactively: Download Postman Collection

OpenAPI Specification Import our OpenAPI spec into your preferred API development tool: View OpenAPI Spec

Code Examples

The API documentation includes code examples in multiple languages:

• cURL — For command-line testing
• JavaScript — For web applications and Node.js
• PHP — For server-side integrations

Visit the full API documentation to view examples for each endpoint.

Rate Limits and Best Practices

To ensure reliable service for all users, please follow these guidelines:

• Cache data locally where possible rather than making repeated requests
• Use pagination for large data sets
• Implement exponential backoff for retry logic
• Only request the data you need
• Store your API token securely and never expose it in client-side code

Error Handling

The API returns standard HTTP status codes:

Webhooks (Subscriptions)

For real-time notifications when data changes, use the Subscriptions endpoints to register webhook URLs. Worx Safety will send HTTP POST requests to your specified URL when events occur.

POST /api/subscription/create
POST /api/subscription/delete
GET /api/subscription/index

Need Help?

If you need assistance with your API integration:

• Email: [email protected]
• Phone: 1300 995 223
• Help Centre: support.worxsafety.com.au

For complex integrations or custom development requirements, contact our team to discuss your needs.