Reference · built on requestConnectorHR, scheduling & workforce

Homebase

Locations, employees, shifts, timecards, labor totals, and timeclock status from Homebase accounts.

About

Homebase is scheduling, time tracking, and team communication software for hourly teams, organized by company and location. Its Public API returns the company, each location, the employees and jobs at that location, scheduled shifts, timecards with breaks, and labor totals grouped by hour, day, role, or employee. Every request carries the Accept header application/vnd.homebase-v1+json, and dates arrive in ISO 8601.

Through Fibric, an operator reads a location's shifts and timecards for a date range, compares scheduled labor with actual labor, and proposes what a manager should check. The API is read-only, so any change you approve is made in Homebase by a person, and Fibric keeps the record of what was proposed and why.

This is a reference listing. It documents what Fibric would read from Homebase and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • The company for the account and its locations through GET /company and GET /locations, with each location's time_zone
  • Employees and their jobs for a location through GET /locations/{location_uuid}/employees, including default_role, wage_rate, roles, and archived_at
  • Scheduled shifts for a date range through GET /locations/{location_uuid}/shifts, with published, open, start_at, end_at, and scheduled labor
  • Timecards with clock_in, clock_out, timebreaks, approved, and actual labor through GET /locations/{location_uuid}/timecards
  • IDs of deleted shifts and timecards through the /shifts/deleted and /timecards/deleted endpoints for a date range
  • Aggregate labor for a location grouped by hour or day, by role, or by employee through the /labor endpoints
  • Current timeclock status for a job through GET /timeclock/status, including mandated_breaks and auto_clock_out settings

Proposed actions

Read-only. Actions need a separate connector.

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Catch overtime before the week closes

    Scheduled labor on each shift carries scheduled_overtime and scheduled_weekly_overtime. The operator compares it with timecard labor as the week runs and proposes which shifts a manager should trim or reassign.

    With Overtime Guard

  • Flag missed and mismatched punches

    A shift with no timecard, or a clock_in far from start_at, shows in one read of the two endpoints. The operator proposes a list for the manager to resolve before payroll.

    With Missed Punch, Punch Match

  • Check breaks against the mandated rule

    Timecards carry timebreaks with mandated_break_id, and labor totals carry break_penalty. The operator proposes which timecards need a break correction and shows the penalty at stake.

    With Break Compliance

  • Track labor against the plan by day

    Labor grouped by day or by role gives regular_hours, paid_hours, and costs per location. The operator proposes where the week is running over budget and why.

    With Labor Budget

Requirements

  • A Homebase account whose API Settings page shows an approved API key
  • The Accept header application/vnd.homebase-v1+json on every request
  • The location_uuid for each location you want to read, from GET /locations
  • A start_date and end_date for shift, timecard, and labor queries
Authentication
A Homebase API key requested from the API Settings page and approved by Homebase, sent as a Bearer token in the Authorization header.

Limits

  • The public API key is read-only. Homebase grants write permissions separately, so this listing proposes changes for a person to make
  • Requests whose URL includes a UUID are limited to 60 per minute per UUID; exceeding it returns 429 Rate limit exceeded
  • No webhooks are documented; changes are found by polling shifts and timecards and the deleted-ID endpoints
  • Responses are paginated with Total, Per-Page, and Link headers, so a history load walks pages one location at a time

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request Homebase ↗

Questions and answers

Is the Homebase API read-only?
Yes for the key you request from API Settings. The documentation describes it as read only and lists only GET endpoints. Write permissions are arranged separately through a Homebase representative.
How do I find out what changed since my last read?
There are no webhooks. Query shifts and timecards by start_date and end_date, and call /shifts/deleted and /timecards/deleted for the IDs removed in that range. Pagination arrives in the Total, Per-Page, and Link response headers.
What does the labor endpoint return?
GET /locations/{location_uuid}/labor returns aggregate labor for a date range grouped by hour or by day; /labor/by_role and /labor/by_employee group it by role or employee. Fields include regular_hours, paid_hours, weekly_overtime, daily_overtime, unpaid_break_hours, break_penalty, costs, and cash and credit tips.
Ask about Homebase

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.