ShiftCare provides a secure, self-service portal for generating and managing API keys. This feature allows Admins to integrate ShiftCare with third-party applications without needing to contact Support.
Note: This feature is available to Premium and Enterprise plans only and is restricted to users with Admin access. If you would like access, please contact your Account Manager or cs@shiftcare.com
This feature is a completely self-serve feature. We do not provide support beyond providing access and this documentation.
Generating a New API Key
To create a new key for an integration:
Navigate to Integrations > API from the sidebar menu.
Click the 'Generate New API Key' button.
For security purposes, you will be prompted to re-authenticate before the key is generated. Please enter your password or complete the 2FA verification to proceed.
Copying Your Key
Once generated, the API Key will be displayed.
⚠️ Important: This key is shown only once.
Click 'Copy' to save it to your password manager or secure storage immediately.
Once you copy it, you will not be able to view the raw key again. If you lose it, you will need to generate a new one.
Deleting Your Key
If a key is compromised or no longer needed, you should delete it immediately to prevent unauthorised access.
To remove the key you generated, click 'Delete'.
Confirm the action. The key will stop working immediately.
There will be a pop-up displaying the successful deletion of your API key.
Frequently Asked Questions
Why are my API requests returning an HTTP 401 Unauthorized error?
This issue is almost always caused by an incorrect Basic Authentication format. A common mistake is placing the API key in the username field and leaving the password blank.
To authenticate correctly with the ShiftCare API, you must format your Basic Auth credentials as follows:
Username: Your Account ID (your numeric account ID, not the API key)
Password: Your API Key
To authorise your request, you must use the following format: (ACCOUNT_ID + ":" + API_KEY)
Example: If your Account ID is 12345 and your API key is sk_abc123, the correct format to use is: (12345:sk_abc123).
Also check if you are connecting to the API for your region:
🇦🇺 AUSTRALIA |
|
🇨🇦 CANADA |
|
🇺🇸 UNITED STATES |
|
🇬🇧 UNITED KINGDOM |
|
Where can I find my account number?
You can locate your account number by navigating to Account > Settings and looking at the URL in your browser's address bar. The string of numbers at the very end of the link is your Account ID.
In this screenshot, the account number is 657884:
