Shiftbase
Find setup guidance and reference information for the Shiftbase source connector on this page.
Prerequisites
You’ll need the following to set up the Shiftbase source connector:
- A Shiftbase account with API access
- An Access Token generated from the Shiftbase App Center
Generate an Access Token
- Log in to your Shiftbase account.
- Go to the App Center.
- Generate a new API Access Token.
- Copy and securely store the token. You’ll need it to configure the connector.
Setup guide
Set up Shiftbase
Airbyte Cloud
- Log into your Airbyte Cloud account.
- Click Sources, then click + New source.
- On the Set up the source page, select Shiftbase from the Source type dropdown.
- Enter a name for the Shiftbase connector.
- Enter your Access Token from the Shiftbase App Center.
- Enter your Start Date for historical data sync using the YYYY-MM-DD format.
- Optionally, enter a Schedule Report End Date using the YYYY-MM-DD format. This sets the Schedule Detail Report stream’s end date. If omitted, it defaults to one month into the future.
- Click Set up source.
Airbyte Open Source
- Go to the Airbyte Open Source dashboard.
- Click Sources, then click + New source.
- On the Set up the source page, select Shiftbase from the Source type dropdown.
- Enter a name for the Shiftbase connector.
- For Access Token, enter the Shiftbase API access token generated in the App Center.
- For Start Date, enter the date in
YYYY-MM-DDformat. Data from this date onwards will be replicated. - Optionally, for Schedule Report End Date, enter a date in
YYYY-MM-DDformat. This sets the Schedule Detail Report stream’s end date. If omitted, it defaults to one month after the current date. - Click Set up source.
Supported sync modes
The Shiftbase source connector supports these sync modes:
- Full Refresh - Overwrite
- Full Refresh - Append
- Incremental - Append for supported streams
- Incremental - Append + Deduped for supported streams
Supported streams
| Stream | Sync Mode | Description |
|---|---|---|
| Departments | Full Refresh | Internal departments within the Shiftbase account |
| Employees | Full Refresh | List of employees (PII fields like name are excluded) |
| Absentees | Full Refresh, Incremental | Records of employee absences and leave |
| Employee Time Distribution | Full Refresh, Incremental | Distribution of worked and planned hours per employee |
| Availabilities | Full Refresh, Incremental | Employee availability slots and preferences |
| Shifts | Full Refresh | Scheduled work shifts and roster details |
| Users | Full Refresh | User account details (PII excluded, flattened structure) |
| Employees Report | Full Refresh | Employees report data |
| Timesheet Detail Report | Full Refresh, Incremental | Detailed timesheet report data |
| Schedule Detail Report | Full Refresh, Incremental | Detailed schedule report data |
Performance considerations
The Shiftbase API applies rate limits. The connector handles them automatically using exponential backoff. If you encounter rate-limit issues, consider:
- Reducing the sync frequency
- Using incremental sync where available to minimise API calls
Data type map
| Shiftbase Type | Airbyte Type |
|---|---|
string | string |
integer | integer |
boolean | boolean |
object | object |
array | array |
date | string |
datetime | string |
Limitations and troubleshooting
Expand to review
Connector limitations
- The
usersstream is flattened and excludes PII, including names, emails, phone numbers and addresses, for privacy compliance. - The
employeesstream excludes thenamefield to minimise PII exposure. - Some report streams make daily API calls. Large date ranges may therefore take longer to sync.
Troubleshooting
- Connection test fails: Check that your access token is valid and hasn’t expired.
- Empty streams: Check that your Shiftbase account contains data for the requested date range.
- Rate limiting: The connector handles rate limits automatically. Extended syncs may take longer if they frequently reach those limits.
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.0.10 | 2026-11-10 | 91721 | Update dependencies |
| 0.0.9 | 2026-11-03 | 90745 | Update dependencies |
| 0.0.8 | 2026-10-20 | 89396 | Update dependencies |
| 0.0.7 | 2026-10-13 | 88794 | Update dependencies |
| 0.0.6 | 2026-10-06 | 88035 | Update dependencies |
| 0.0.5 | 2026-09-29 | 87329 | Update dependencies |
| 0.0.4 | 2026-09-22 | 86801 | Update dependencies |
| 0.0.3 | 2026-09-15 | 86200 | Update dependencies |
| 0.0.2 | 2026-09-08 | 85666 | Update dependencies |
| 0.0.1 | 2026-08-27 | 72899 | Initial release |