Crystal Payroll REST API
Partner
Build customer integrations with Crystal Payroll
Crystal Payroll provides a developer-ready REST API for approved developers, software vendors and technology partners building custom integrations with Crystal Payroll. Our API is documented using the OpenAPI Specification (OAS).
API Overview
The Crystal Payroll REST API enables approved developers, software vendors and technology partners to securely connect their applications and systems with Crystal Payroll. It can be used to build custom integrations, automate workflows and exchange authorised payroll data between Crystal Payroll and other business systems.
The API is documented using the OpenAPI Specification (OAS), providing developers with a structured technical reference for the available API functionality. Developer access is subject to an application and approval process, ensuring integrations are appropriately reviewed before credentials are provided.
The Crystal Payroll API is available for custom third-party integrations and is not limited to Crystal Payroll’s existing software integrations.
What can you build?
The Crystal Payroll API can support a range of custom integration and automation projects, including:
- Time and attendance – connect custom timesheet and workforce management applications
- HR workflows – automate employee and onboarding processes
- Data synchronisation – exchange authorised employee and payroll information between systems
- Custom applications – build internal or commercial applications that connect with Crystal Payroll
- Reporting and data pipelines – move authorised payroll data into other business systems
If you are developing a software product or integration that needs to connect with Crystal Payroll, our developer access process allows us to understand your requirements and provide the appropriate access.
Developer API access
Crystal Payroll supports third-party developers, software vendors, technology partners and internal IT teams building custom integrations.
API access is controlled through a developer application and approval process. This is important because payroll systems contain sensitive employee, financial and New Zealand payroll information.
The API documentation follows the OpenAPI Specification (OAS), but API access itself is not unrestricted public or self-service access. Developers must apply and be approved before API credentials are provided.
This process allows Crystal Payroll to understand the proposed integration, verify the developer or organisation, and establish appropriate access to authorised client environments.
How to get Crystal Payroll API access
Getting started with the Crystal Payroll API involves a simple developer access process.
1
Apply for developer access
Complete the developer application with information about your organisation, software platform and proposed integration.
This gives our team the information needed to understand what you are building and how the API will be used.
2
Application review and provisioning
Our team reviews your request and, once approved, provisions your developer access and credentials.
Where required, we can also discuss the proposed integration architecture and development environment.
3
Configure authorised access
Once developer access has been provisioned, your integration can be configured for the appropriate authorised Crystal Payroll client environment.
Access permissions are established according to the approved integration requirements.
4
Start developing
With your developer credentials available, your development team can use the API documentation to begin building and testing your integration.
API documentation
The Crystal Payroll API is documented using the OpenAPI Specification (OAS), a widely used standard for describing REST APIs.
The API documentation provides developers with the technical information needed to understand the available API resources and build integrations with Crystal Payroll.
For the latest technical reference, visit the Crystal Payroll API documentation:
The API documentation is intended for developers and technical teams who are evaluating or building a custom integration with Crystal Payroll.
Who is the Crystal Payroll API for?
The Crystal Payroll API is designed for technical teams building custom connections to Crystal Payroll, including:
Software developers
Developers building applications that need to exchange authorised data with Crystal Payroll.
Software companies
SaaS providers and commercial software vendors developing integrations between their platform and Crystal Payroll.
Technology partners
Integration providers and technology partners developing solutions for Crystal Payroll customers.
Internal IT teams
Corporate IT and development teams building internal applications, automation or data workflows involving Crystal Payroll.
Integration specialists
Developers and consultants responsible for connecting payroll with HR, timekeeping, accounting, workforce management or other business systems.
Frequently Asked Questions
Does Crystal Payroll have an API?
Yes. Crystal Payroll provides a developer-ready REST API for approved third-party developers, software vendors, technology partners and internal IT teams building custom integrations.
Is the Crystal Payroll API public?
The Crystal Payroll API is not an unrestricted public, self-service API. Developer access is subject to an application and approval process before credentials are issued.
Can third-party developers build integrations with Crystal Payroll?
Yes. Crystal Payroll supports third-party developers and software providers who want to build custom integrations. Developers need to apply for access and have their proposed integration approved before receiving developer credentials.
Does Crystal Payroll use OpenAPI?
Yes. The Crystal Payroll API documentation uses the OpenAPI Specification (OAS), a standard format for describing REST APIs.
How do I get Crystal Payroll API credentials?
Developers need to apply for developer API access. Crystal Payroll reviews the application and, once approved, provisions the appropriate developer credentials and access.
Where can I find the Crystal Payroll API documentation?
The technical API documentation is available through the Crystal Payroll API documentation portal.
Is the API suitable for commercial software products?
Yes. Crystal Payroll welcomes enquiries from software vendors and technology providers developing commercial integrations, subject to the developer access and approval process.
Ready to start building?
Start your Crystal Payroll API project
Building a custom integration with Crystal Payroll?
Tell us what you are building and our team can help you understand the developer access process.
Copyright © 2026 Crystal Payroll. All rights reserved.
Want to stay up to date with us?Subscribe to our newsletter
