Skip to main content

Shiftbase

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

Generating an Access Token

  1. Log in to your Shiftbase account
  2. Navigate to the App Center
  3. Generate a new API Access Token
  4. Copy and securely store the token - you'll need it for the connector configuration

Setup guide

Set up Shiftbase

For Airbyte Cloud

  1. Log into your Airbyte Cloud account.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Shiftbase from the Source type dropdown.
  4. Enter a name for the Shiftbase connector.
  5. Enter your Access Token from the Shiftbase App Center.
  6. Enter your Start Date for historical data sync (format: YYYY-MM-DD).
  7. Optionally, enter a Schedule Report End Date (format: YYYY-MM-DD) to set the end date for the Schedule Detail Report stream. Defaults to 1 month into the future if not provided.
  8. Click Set up source.

For Airbyte Open Source

  1. Navigate to the Airbyte Open Source dashboard.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Shiftbase from the Source type dropdown.
  4. Enter the name for the Shiftbase connector.
  5. For Access Token, enter your Shiftbase API access token generated from the App Center.
  6. For Start Date, enter the date in YYYY-MM-DD format. Data from this date onwards will be replicated.
  7. Optionally, for Schedule Report End Date, enter a date in YYYY-MM-DD format to set the end date for the Schedule Detail Report stream. If not provided, it defaults to 1 month into the future from the current date.
  8. Click Set up source.

Supported sync modes

The Shiftbase source connector supports the following sync modes:

Supported Streams

StreamSync ModeDescription
DepartmentsFull RefreshInternal departments within the Shiftbase account
EmployeesFull RefreshList of employees (PII fields like name are excluded)
AbsenteesFull Refresh, IncrementalRecords of employee absences and leave
Employee Time DistributionFull Refresh, IncrementalDistribution of worked and planned hours per employee
AvailabilitiesFull Refresh, IncrementalEmployee availability slots and preferences
ShiftsFull RefreshScheduled work shifts and roster details
UsersFull RefreshUser account details (PII excluded, flattened structure)
Employees ReportFull RefreshEmployees report data
Timesheet Detail ReportFull Refresh, IncrementalDetailed timesheet report data
Schedule Detail ReportFull Refresh, IncrementalDetailed 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 TypeAirbyte Type
stringstring
integerinteger
booleanboolean
objectobject
arrayarray
datestring
datetimestring

Limitations & Troubleshooting

Expand to review

Connector limitations

  • The users stream is flattened and excludes PII (names, emails, phones, addresses) for privacy compliance
  • The employees stream has the name field 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

Config fields reference

Field
Type
Property name
string
access_token
string
start_date
string
schedule_report_end_date

Changelog

Expand to review
VersionDatePull RequestSubject
0.0.12026-08-2772899Initial release