Contents of this article are applicable to the following users
Tier: NA
Product: Workspace API
Platform: Web
Access Level: Owner/Manager
Use Workspace API to securely connect selected StaffAny workspace data to external tools for reporting, automation, integrations, and AI-assisted workflows.
This guide will cover the following:
What is Workspace API?
Workspace API is a secure way for approved customers to let another tool read or update selected StaffAny data. It is designed for teams that want to connect StaffAny with reporting tools, dashboards, internal systems, automations, or AI tools.
API access is scoped to the StaffAny account that creates the API key. This means the API key can only access data and actions that the StaffAny user account is allowed to access.
What can you use Workspace API for?
Common use cases include:
Building custom reports with StaffAny workspace data
Creating dashboards or analysis workflows outside StaffAny
Using AI tools to analyse staff, schedule, timesheet, payroll, compensation, sales, or day-off data
Pulling approved StaffAny data into another business system
Automating approved workflows that need to read from or write to StaffAny
Workspace API is actively maintained. If your use case requires data or actions that are not currently available, share the use case with the StaffAny team so we can review demand and feasibility.
Read Access vs Write Access
Read access is currently free for all StaffAny organisations while Write access is a premium feature. It currently covers several StaffAny workspace areas, including Identity, Groups, Sales, Scheduling, Staff, Wall, Leaves, Payroll, and Compensations.
Read access | Lets an external tool extract approved data from StaffAny. This is commonly used for reports, dashboards, analysis, and AI-assisted workflows. Changes made outside StaffAny will not update data in the StaffAny web app. |
Write access | Lets an external tool update approved data in StaffAny. Write access is available only for approved use cases, must be enabled separately, and may be chargeable depending on your region and contract. |
If you are unsure whether your use case needs read access or write access, start by describing what you want to build and whether the external tool needs to change data inside StaffAny and we will advise accordingly.
Using Workspace API with AI tools
Workspace API can be used with coding agents and AI tools such as Claude, Codex, or similar tools when you want to build reports, analyse data, or prototype workflows.
Setup screens and prompts may differ by tool, but the StaffAny requirements are the same: use the current API documentation and your own Workspace API key. The video above shows the entire set up flow, from start to prompt.
What you need to get started
AI coding agent (e.g. Codex, Claude)
Workspace API access enabled for your StaffAny workspace
A StaffAny user account with the permissions needed for the data or actions you want to access
Workspace API Documentation, available at https://api.staffany.com/docs
A Workspace API key generated from StaffAny
What is API Documentation?
API documentation is the guide for users to understand how to connect with Workspace API. It explains what data and actions are available, what requests to send, and what responses to expect. Use the latest API documentation whenever you build or update an integration, report, automation, or AI-assisted workflow. Workspace API documentation is available at https://api.staffany.com/docs.
How to generate and protect your API key
Anyone with access to the StaffAny web app may be able to generate a Workspace API key. The key uses the same permissions as the StaffAny account that created it.
To generate your API key, go to app.staffany.com, under Settings → Account & Security → Workspace API Keys. From there, click Generate Key to get your API key. Note that it will only be shown once so do store it safely.
The API key will only be displayed once. Refer to the set up video above on the best way to store your API key.
Treat your API key like a password:
Do not share it in chat, email, documents, screenshots, or public repositories.
Store it only in secure tools that are meant for secrets or credentials.
Use a StaffAny account with only the permissions required for the integration.
Replace the key if you believe it was exposed or used by the wrong person.
FAQ
How do I get access to Workspace API?
Contact your StaffAny representative or Support team with your intended use case. StaffAny will review the request and enable access if approved.
Can Workspace API update StaffAny data?
Yes, but only for approved write use cases. Write access is enabled separately from read access and may be chargeable.
Is Workspace API fully self-serve?
Not yet. API access must be enabled for your workspace first, and write use cases require additional review.
Is Claude setup the same as Codex setup?
Generally, yes. Both need the current StaffAny API documentation and your Workspace API key. The exact setup steps may differ slightly by tool.
I can't rename my API key file to .env on Mac, a warning message pops up.
The message is to prevent people from accidentally deleting important, hidden files. Files that start with "." are hidden. To "unlock" this ability, simply press cmd+shift+. when in the folder.
What should I do if I cannot access the data I need?
Share the business use case with StaffAny. The team can confirm whether the data is currently supported or whether the request should be reviewed for future API coverage.
What do I do when Workspace API gets updated?
If Workspace API is updated, download the latest API specification or reference material from the documentation site before continuing development. This helps your external tools use the latest available endpoints and data definitions.
Who should I contact for help?
For access, billing, or general setup questions, contact your StaffAny representative. For complex reports or integrations, reach out to us via our in-app help chat.
How do I get write access to the API?
Contact your StaffAny representative or Support team with your intended use case. StaffAny will further assist you with the pricing plan and enabling write access. Once enabled, no changes need to be made on your end!