The Nory API (application programming interface) lets other software, such as an HR, employee engagement or payroll tool, read your team's details from Nory. This means you don't have to keep the same people data up to date in two places.
Who this applies to: any Nory brand can ask for API access by contacting Nory Support.
What data the Nory API includes
The Nory API covers your people and how your business is organised.
Data | What it includes |
People | Names, work contact details, start dates, positions and home location. |
Organisation | Locations, positions and departments, so the connected tool can match each person to where and how they work. |
Adding new starters | A connected tool with a read and write key can create new people in Nory. |
Personal details, such as date of birth, home address and bank details, are only shared through the Nory API once your business has signed a data agreement with Nory.
What the Nory API doesn't include
This data isn't available through the Nory API today:
Sales
Stock
Purchasing
Schedules
Hours
Finance reports, including profit and loss (P&L)
Getting data as a daily scheduled file instead
Some data that isn't in the Nory API can be sent to you as a file once a day instead. Nory delivers the file to secure cloud storage, either Nory's storage or your own, and keeps each file for 5 days by default, or longer if agreed when the export is set up. This applies only when Nory stores them, if the files go to their own storage, they decide how long to keep them.
Available as a daily scheduled file:
Labour hours and labour cost by location
Shifts and timecards
Supplier invoices
Stock counts, waste and recipes
Not available as a daily scheduled file today:
Sales
Profit and loss (P&L) reports
To set up a daily scheduled file, contact Nory Support.
If you only need a one-off file, you can export a lot of this data yourself from Nory. Read What can I export from Nory, and where?
How to get an API key
An API key is a secret code that lets one specific tool access your Nory data. Each key is created for your business and one tool.
Connecting All Gravy? Admins can create an All Gravy key themselves in Settings > Integrations, without contacting Support. Read How do I connect All Gravy to Nory?
To get a key for any other tool, follow these steps:
Contact Nory Support. Tell us which tool you want to connect, and whether the tool needs to add new people to Nory.
Nory creates a key for your business and that tool. Keys are read only by default. If the tool needs to add new people, ask for a read and write key.
Nory sends you the key once, through a secure link. Save the key in a password manager straight away.
Give the key to the tool securely, for example through a password manager or a one-time sharing link. Don't paste the key into a plain email or chat message.
Read only and read and write keys
The key type controls whether the connected tool can only read your data, or can also add people to Nory.
Key type | What the connected tool can do |
Read only | Read your people and organisation data. The tool can't change anything in Nory. |
Read and write | Read the same data, and add new people to Nory. |
Keeping your API key safe
Treat your API key like a password, because anyone with the key can access your Nory data.
Only share the key with the tool it was created for.
Nory will never ask you for your API key. If someone asks you for the key, don't share it.
To switch a key off (revoke it), contact Nory Support. Once a key is revoked, the connected tool can't access your Nory data.
Request limits
Each API key has a fair-use limit on how many requests the connected tool can make per minute. The limit is set well above normal use. If you need a higher limit, talk to your account manager.
If a tool goes over the limit:
Nory refuses the request with a “too many requests” error.
The error tells the tool how many seconds to wait before trying again. This is a minute at most.
After that wait, the tool can send the request again.
Nothing else is blocked, and your other API keys keep working as normal.
For your technical team
Share these links with the developer or provider setting up the connection:
Developer guides: api.prod.nory.ai/developers
Full API reference: api.prod.nory.ai/docs
Still need help?
Contact Nory Support and have this ready:
Your brand name
The tool you want to connect, or are already connected to
What data the tool needs, and whether it needs to add people to Nory
Any error message the tool shows
