Shiftbase [ARCHIVED]
This page contains the setup guide and reference information for the Shiftbase source connector.
Prerequisites
To set up the Shiftbase source connector, you'll need:
- A Shiftbase account with API access
- An Access Token generated from the Shiftbase App Center
- The Account Name for tracking purposes (you can use any identifier)
Generating an Access Token
- Log in to your Shiftbase account
- Navigate to the App Center
- Generate a new API Access Token
- Copy and securely store the token - you'll need it for the connector configuration
Setup guide
Set up Shiftbase
For Airbyte Cloud
- Log into your Airbyte Cloud account.
- Click Sources and 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 Account Name (an identifier for tracking).
- Enter your Access Token from the Shiftbase App Center.
- Enter your Start Date for historical data sync (format: YYYY-MM-DD).
- Click Set up source.
For Airbyte Open Source
- Navigate to the Airbyte Open Source dashboard.
- Click Sources and then click + New source.
- On the Set up the source page, select Shiftbase from the Source type dropdown.
- Enter the name for the Shiftbase connector.
- Add one or more Accounts with:
- Access Token: Your Shiftbase API access token generated from the App Center
- Account Name: A name to identify the account
- For Start Date, enter the date in
YYYY-MM-DDformat. Data from this date onwards will be replicated. - Click Set up source.
Multiple Accounts
The Shiftbase connector supports syncing data from multiple Shiftbase accounts simultaneously. When configuring the connector, you can add multiple account configurations, each with its own access token and account name.
Supported sync modes
The Shiftbase source connector supports the following 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 has rate limiting in place. The connector handles rate limits automatically with exponential backoff. If you encounter rate limit issues, consider:
- Reducing the sync frequency
- Using incremental sync where available to minimize API calls
Data type map
| Shiftbase Type | Airbyte Type |
|---|---|
string | string |
integer | integer |
boolean | boolean |
object | object |
array | array |
date | string |
datetime | string |
Limitations & Troubleshooting
Expand to review
Connector limitations
- The
usersstream is flattened and excludes PII (names, emails, phones, addresses) for privacy compliance - The
employeesstream has thenamefield removed to minimize PII exposure - Some streams (reports) make day-by-day API calls which may result in longer sync times for large date ranges
Troubleshooting
- Connection test fails: Verify your access token is valid and has not expired
- Empty streams: Ensure your Shiftbase account has data for the requested date range
- Rate limiting: The connector handles rate limits automatically, but extended syncs may take longer if limits are hit frequently
Reference
No configuration specification is available for this connector.
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.0.1 | 2026-02-03 | 72899 | Initial release |