Your payroll, HR or reporting software needs data that lives in NextCrew. The API moves it for you, so nobody exports and retypes it.
Summary
The NextCrew API lets other software read and update your NextCrew data: Crew Members, clients, orders, jobs, offers, timesheets, reports and lookup tables. Webhooks tell your other software the moment something changes. To connect, create an API key on your Profile and give it to your developer or technical partner. The full documentation, with a place to try requests, is at api.nextcrew.app. What goes wrong: sharing a key by email or chat. Anyone with it can reach your data.
How to do it
- Click your initials at the top right and choose Profile.
- Open the API Keys tab and click ADD.
- Give the key a name that says what it's for, such as Payroll sync, and click Add.
- Copy the key straight away and store it somewhere safe. You won't see it again.
- Give it to your developer or partner securely, with a link to api.nextcrew.app.
- When an integration stops being used, delete its key.
▶ Watch how to create an API key (under 1 minute)
That's your software connected. Everything below is for your developer, or for when something stops working.
On this page
What you can connect
| Area | What the API can do |
|---|---|
| Crew Members (HR) | Create, update and look up Crew Members, with their contacts, locations and notes. |
| Clients (CRM) | Create and update clients, locations, notes, workers' comp codes and Crew preferences. |
| Orders, jobs and offers (Workspace) | Create and update orders, jobs and offers, and their notes. |
| Timesheets (Operation) | Create, update and look up timesheets and their notes. |
| Reports | Export a report, or create a link to one. |
| Data import | Send a client import and check its errors. |
| Settings and lookup tables | Positions, rate configurations, groups, tags, HR statuses, lines of business, workers' comp codes and company settings. |
| Webhooks | Get a message sent to your software when records change. |
Why connect instead of exporting
| Without the API | With the API |
|---|---|
| Exporting a spreadsheet and importing it somewhere else | The other software reads the data directly. |
| Checking for changes by hand | A webhook tells your software the moment a record changes. |
| Typing the same Crew Member into two systems | Create it once and send it where it's needed. |
For your developer
- Base address:
https://api.nextcrew.app - Sign-in: send the key in the
Authorizationheader as a bearer token:Authorization: Bearer sk_... - Try it: the documentation at api.nextcrew.app lets you enter the key and send live requests, with sample code. No other tool is needed.
- Errors: returned as Problem Details (RFC 9457), with a
status,titleanddetail. - Rate limits: too many requests in a minute returns
429 Too Many Requests, with aRetry-Afterheader. Wait, then retry. - OpenAPI file: download it from the documentation to generate a client.
⚠️ Watch out
A key works on live data. Test with care: creating or deleting records through the API does the same as doing it on screen.
Webhooks: get told when something changes
A webhook sends a message to an address your developer chooses whenever a record is created, updated or deleted. Your developer sets them up through the API.
Records you can follow: background checks, clients, Crew Members, Crew Member certifications, documents, licenses and tax details, custom fields, contacts, jobs, locations, network invitations, offers, orders, tasks and timesheets.
Each delivery is logged with its status (Pending, Success or Failed), so your developer can see what was sent.
Keep keys safe
- A key belongs to the person who created it, and it can do only what that person is allowed to do in NextCrew. Create it from an account with the access the integration needs, and no more.
- Use one key for each integration. Then you can delete one without breaking the others.
- Treat a key like a password. Don't paste it into email or chat.
- Lost a key, or someone left? Delete it and create a new one.
Questions people ask
Where do I create an API key?
Click your initials at the top right, choose Profile, and open the API Keys tab.
Can I see a key again after I create it?
No. Copy it when you create it. If it's lost, delete it and create a new one.
What can a key do?
The same things the person who created it can do in NextCrew. If their permissions change, so does what the key can do.
Do I need Postman or another tool to test?
No. You can send test requests from the documentation at api.nextcrew.app.
Do I need a developer?
Usually. The API is for software to talk to software. Ask your developer or the partner you're connecting.
Can NextCrew tell my system when something changes?
Yes. Use webhooks.
Other ways people ask this
- How do I get an API key?
- Does NextCrew have an API?
- Where is the API documentation?
- How do I connect NextCrew to our payroll system?
- Does NextCrew support webhooks?
- Open API
Related guides
- Update Your Profile and Password — where the API Keys tab is
- App Marketplace: Start Here — ready-made connections, no code needed
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article