Homebase

App · 16 actions

Read your Homebase schedules, timecards, employees and labor costs, and start workflows when shifts change or employees clock in and out.

Actions

ActionWhat it does
Get companyGet your Homebase company's name and its owner.
Get employeeGet one employee at a location, with their role, wage and PIN.
Get labor by employeeGet each employee's hours, overtime, time off, pay and tips at a location for a period, as for a payroll export.
Get labor by roleGet a location's hours, overtime, labor cost and tips for a period, for each role (Server, Cook and so on).
Get labor totalsGet a location's hours worked, overtime, labor cost and tips for a period, by day or by hour.
Get locationGet one location's name, address, phone and time zone.
Get location planGet the Homebase plan a location is on, its price and whether it is in a trial.
Get shiftGet one shift with its times, employee, role and scheduled labor.
Get timecardGet one timecard with its clock times, breaks, hours and tips.
Get timeclock statusCheck whether an employee is clocked in, on a break or clocked out right now, with their current shift.
List deleted shiftsList shifts removed from a location's schedule in a period: each shift's id, its times and when it was deleted.
List deleted timecardsList timecards deleted at a location in a period: each one's id, clock times and when it was deleted.
List employeesList a location's employees with their contact details, role, wage and payroll id.
List locationsList your business's locations with their address and time zone.
List shiftsList a location's scheduled shifts in a period, with who works them, their role and the scheduled hours and cost.
List timecardsList a location's timecards in a period: clock-in and clock-out times, breaks, hours, tips and whether a manager approved them.

Get company

Get your Homebase company's name and its owner.

Inputs

None.

Outputs

companyobject
The company
Example output
{
  "company": {
    "created_at": "2025-06-01T12:00:00Z",
    "name": "Main Street Cafe LLC",
    "owner": {
      "created_at": "2026-01-10T15:00:00Z",
      "email": "jo@example.com",
      "first_name": "Jo",
      "id": 4521,
      "job": {
        "archived_at": null,
        "default_role": "Server",
        "level": "Employee",
        "location_uuid": "f9e46145-b6b1-4e9e-92a0-320510e2c1f3",
        "payroll_id": "E-102",
        "pin": "1234",
        "pos_partner_id": null,
        "roles": [
          {
            "name": "Server",
            "wage_rate": 15.5
          }
        ],
        "wage_rate": 15.5,
        "wage_type": "hourly"
      },
      "last_name": "Bloggs",
      "phone": "5555550100",
      "updated_at": "2026-10-01T15:00:00Z"
    },
    "updated_at": "2026-09-01T12:00:00Z"
  }
}

Get employee

Get one employee at a location, with their role, wage and PIN.

Inputs

Locationlocation_uuidtextRequired
The Homebase location. Pick one, or give its id from an earlier step.
Employeeemployee_idtextRequired
The employee. Pick one, or give their id from an earlier step.
Include archived employeeswith_archivedtrue/false
Also include employees who have been archived (no longer on the team).

Outputs

employeeobject
The employee
Example output
{
  "employee": {
    "created_at": "2026-01-10T15:00:00Z",
    "email": "jo@example.com",
    "first_name": "Jo",
    "id": 4521,
    "job": {
      "archived_at": null,
      "default_role": "Server",
      "level": "Employee",
      "location_uuid": "f9e46145-b6b1-4e9e-92a0-320510e2c1f3",
      "payroll_id": "E-102",
      "pin": "1234",
      "pos_partner_id": null,
      "roles": [
        {
          "name": "Server",
          "wage_rate": 15.5
        }
      ],
      "wage_rate": 15.5,
      "wage_type": "hourly"
    },
    "last_name": "Bloggs",
    "phone": "5555550100",
    "updated_at": "2026-10-01T15:00:00Z"
  }
}

Get labor by employee

Get each employee's hours, overtime, time off, pay and tips at a location for a period, as for a payroll export.

Inputs

Locationlocation_uuidtextRequired
The Homebase location. Pick one, or give its id from an earlier step.
Fromstart_datedate and time
Start of the period. Leave empty for 7 days ago (or a week before 'Until').
Untilend_datedate and time
End of the period. Leave empty for now (or a week after 'From').

Outputs

countnumber
How many were returned
employeeslist
The totals for each employee
end_datetext
End of the period read (UTC)
start_datetext
Start of the period read (UTC)
Example output
{
  "count": 1,
  "employees": [
    {
      "created_at": "2026-01-10T15:00:00Z",
      "email": "jo@example.com",
      "first_name": "Jo",
      "id": 4521,
      "job": {
        "archived_at": null,
        "default_role": "Server",
        "level": "Employee",
        "location_uuid": "f9e46145-b6b1-4e9e-92a0-320510e2c1f3",
        "payroll_id": "E-102",
        "pin": "1234",
        "pos_partner_id": null,
        "roles": [
          {
            "name": "Server",
            "wage_rate": 15.5
          }
        ],
        "wage_rate": 15.5,
        "wage_type": "hourly"
      },
      "labor": {
        "break_penalty": "0.0",
        "cash_tips": "20.0",
        "costs": "120.13",
        "credit_tips": "0.0",
        "daily_overtime": "0.0",
        "double_overtime": "0.0",
        "paid_hours": "7.75",
        "paid_time_off_hours": "0.0",
        "regular_hours": "7.75",
        "scheduled_hours": "8.0",
        "seventh_day_overtime_15": "0.0",
        "seventh_day_overtime_20": "0.0",
        "time_off_hours": "0.0",
        "unpaid_break_hours": "0.5",
        "wage_rate": "15.5",
        "wage_type": "hourly",
        "weekly_overtime": "0.0"
      },
      "last_name": "Bloggs",
      "phone": "5555550100",
      "updated_at": "2026-10-01T15:00:00Z"
    }
  ],
  "end_date": "2026-11-08T00:00:00Z",
  "start_date": "2026-11-01T00:00:00Z"
}

Get labor by role

Get a location's hours, overtime, labor cost and tips for a period, for each role (Server, Cook and so on).

Inputs

Locationlocation_uuidtextRequired
The Homebase location. Pick one, or give its id from an earlier step.
Fromstart_datedate and time
Start of the period. Leave empty for 7 days ago (or a week before 'Until').
Untilend_datedate and time
End of the period. Leave empty for now (or a week after 'From').

Outputs

countnumber
How many were returned
end_datetext
End of the period read (UTC)
roleslist
The totals for each role
start_datetext
Start of the period read (UTC)
Example output
{
  "count": 1,
  "end_date": "2026-11-08T00:00:00Z",
  "roles": [
    {
      "labor": {
        "break_penalty": 0.0,
        "cash_tips": 20.0,
        "costs": 120.13,
        "credit_tips": 0.0,
        "daily_overtime": 0.0,
        "double_overtime": 0.0,
        "paid_hours": 7.75,
        "paid_time_off_hours": 0.0,
        "regular_hours": 7.75,
        "scheduled_hours": 8.0,
        "seventh_day_overtime_15": 0.0,
        "seventh_day_overtime_20": 0.0,
        "time_off_hours": 0.0,
        "unpaid_break_hours": 0.5,
        "wage_rate": 15.5,
        "wage_type": "hourly",
        "weekly_overtime": 0.0
      },
      "role_id": "18",
      "role_name": "Server"
    }
  ],
  "start_date": "2026-11-01T00:00:00Z"
}

Get labor totals

Get a location's hours worked, overtime, labor cost and tips for a period, by day or by hour.

Inputs

Locationlocation_uuidtextRequired
The Homebase location. Pick one, or give its id from an earlier step.
Fromstart_datedate and time
Start of the period. Leave empty for 7 days ago (or a week before 'Until').
Untilend_datedate and time
End of the period. Leave empty for now (or a week after 'From').
Groupgroup_bytext
Totals for each day or for each hour. Defaults to each day.One of: day (By day (default)), hour (By hour).

Outputs

countnumber
How many were returned
end_datetext
End of the period read (UTC)
laborlist
The totals, one per day or hour
start_datetext
Start of the period read (UTC)
Example output
{
  "count": 1,
  "end_date": "2026-11-08T00:00:00Z",
  "labor": [
    {
      "end_date": "2026-11-03",
      "labor": {
        "break_penalty": 0.0,
        "cash_tips": 20.0,
        "costs": 120.13,
        "credit_tips": 0.0,
        "daily_overtime": 0.0,
        "double_overtime": 0.0,
        "paid_hours": 7.75,
        "paid_time_off_hours": 0.0,
        "regular_hours": 7.75,
        "scheduled_hours": 8.0,
        "seventh_day_overtime_15": 0.0,
        "seventh_day_overtime_20": 0.0,
        "time_off_hours": 0.0,
        "unpaid_break_hours": 0.5,
        "wage_rate": 15.5,
        "wage_type": "hourly",
        "weekly_overtime": 0.0
      },
      "start_date": "2026-11-03"
    }
  ],
  "start_date": "2026-11-01T00:00:00Z"
}

Get location

Get one location's name, address, phone and time zone.

Inputs

Locationlocation_uuidtextRequired
The Homebase location. Pick one, or give its id from an earlier step.

Outputs

locationobject
The location
Example output
{
  "location": {
    "address_1": "1 Main Street",
    "address_2": null,
    "city": "Springfield",
    "country_code": "US",
    "created_at": "2025-06-01T12:00:00Z",
    "name": "Main Street Cafe",
    "partner_merchant_id": null,
    "phone": "5555550199",
    "state": "IL",
    "time_zone": "America/Chicago",
    "updated_at": "2026-09-01T12:00:00Z",
    "uuid": "f9e46145-b6b1-4e9e-92a0-320510e2c1f3",
    "website": "https://example.com",
    "zip": "62701"
  }
}

Get location plan

Get the Homebase plan a location is on, its price and whether it is in a trial.

Inputs

Locationlocation_uuidtextRequired
The Homebase location. Pick one, or give its id from an earlier step.

Outputs

planobject
The location's plan
Example output
{
  "plan": {
    "in_trial": false,
    "last_update": "2026-01-01T00:00:00Z",
    "plan": 2,
    "price": 30.0,
    "trial_end_date": null
  }
}

Get shift

Get one shift with its times, employee, role and scheduled labor.

Inputs

Locationlocation_uuidtextRequired
The Homebase location. Pick one, or give its id from an earlier step.
Shift IDshift_idnumberRequired
The shift's id, from 'List shifts' or an earlier step.
Include shift noteswith_notetrue/false
Also return the note added to each shift, with its author.

Outputs

shiftobject
The shift
Example output
{
  "shift": {
    "created_at": "2026-10-28T09:00:00Z",
    "department": "Front of house",
    "end_at": "2026-11-03T22:00:00Z",
    "first_name": "Jo",
    "id": 98001,
    "job_id": 6620,
    "labor": {
      "scheduled_blue_laws_hours": 0.0,
      "scheduled_costs": 116.25,
      "scheduled_daily_overtime": 0.0,
      "scheduled_double_overtimes": 0.0,
      "scheduled_hours": 8.0,
      "scheduled_overtime": 0.0,
      "scheduled_overtime_costs": 0.0,
      "scheduled_regular": 8.0,
      "scheduled_seventh_day_overtime_15": 0.0,
      "scheduled_seventh_day_overtime_20": 0.0,
      "scheduled_spread_of_hours": 0.0,
      "scheduled_unpaid_breaks_hours": 0.5,
      "scheduled_weekly_overtime": 0.0,
      "wage_type": "hourly"
    },
    "last_name": "Bloggs",
    "location_id": 310,
    "note": {
      "author": "Sam Manager",
      "created_at": "2026-10-28T09:00:00Z",
      "text": "Cover the patio.",
      "updated_at": "2026-10-28T09:00:00Z"
    },
    "open": false,
    "published": true,
    "role": "Server",
    "scheduled": true,
    "start_at": "2026-11-03T14:00:00Z",
    "timecard_id": 77001,
    "updated_at": "2026-10-28T09:00:00Z",
    "user_id": 4521,
    "wage_rate": 15.5
  }
}

Get timecard

Get one timecard with its clock times, breaks, hours and tips.

Inputs

Locationlocation_uuidtextRequired
The Homebase location. Pick one, or give its id from an earlier step.
Timecard IDtimecard_idnumberRequired
The timecard's id, from 'List timecards' or an earlier step.

Outputs

timecardobject
The timecard
Example output
{
  "timecard": {
    "approved": false,
    "clock_in": "2026-11-03T13:58:00Z",
    "clock_out": "2026-11-03T22:05:00Z",
    "created_at": "2026-11-03T13:58:00Z",
    "department": "Front of house",
    "first_name": "Jo",
    "id": 77001,
    "job_id": 6620,
    "labor": {
      "break_penalty": 0.0,
      "cash_tips": 20.0,
      "costs": 120.13,
      "credit_tips": 0.0,
      "daily_overtime": 0.0,
      "double_overtime": 0.0,
      "paid_hours": 7.75,
      "paid_time_off_hours": 0.0,
      "regular_hours": 7.75,
      "scheduled_hours": 8.0,
      "seventh_day_overtime_15": 0.0,
      "seventh_day_overtime_20": 0.0,
      "time_off_hours": 0.0,
      "unpaid_break_hours": 0.5,
      "wage_rate": 15.5,
      "wage_type": "hourly",
      "weekly_overtime": 0.0
    },
    "last_name": "Bloggs",
    "payroll_id": "E-102",
    "role": "Server",
    "shift_id": 98001,
    "timebreaks": [
      {
        "created_at": "2026-11-03T18:00:00Z",
        "duration": 30,
        "end_at": "2026-11-03T18:30:00Z",
        "id": 501,
        "mandated_break_id": 12,
        "paid": false,
        "start_at": "2026-11-03T18:00:00Z",
        "timecard_id": 77001,
        "updated_at": "2026-11-03T18:30:00Z",
        "work_period": 300
      }
    ],
    "updated_at": "2026-11-03T22:05:00Z",
    "user_id": 4521
  }
}

Get timeclock status

Check whether an employee is clocked in, on a break or clocked out right now, with their current shift.

Inputs

Job IDjob_idnumberRequired
The employee's job id at the location: the job_id on one of their shifts or timecards.

Outputs

timeclockobject
The timeclock status
Example output
{
  "timeclock": {
    "auto_clock_out_enabled": false,
    "auto_clock_out_minutes": 0,
    "cash_tips_enabled": true,
    "current_shift": {
      "created_at": "2026-10-28T09:00:00Z",
      "department": "Front of house",
      "end_at": "2026-11-03T22:00:00Z",
      "first_name": "Jo",
      "id": 98001,
      "job_id": 6620,
      "labor": {
        "scheduled_blue_laws_hours": 0.0,
        "scheduled_costs": 116.25,
        "scheduled_daily_overtime": 0.0,
        "scheduled_double_overtimes": 0.0,
        "scheduled_hours": 8.0,
        "scheduled_overtime": 0.0,
        "scheduled_overtime_costs": 0.0,
        "scheduled_regular": 8.0,
        "scheduled_seventh_day_overtime_15": 0.0,
        "scheduled_seventh_day_overtime_20": 0.0,
        "scheduled_spread_of_hours": 0.0,
        "scheduled_unpaid_breaks_hours": 0.5,
        "scheduled_weekly_overtime": 0.0,
        "wage_type": "hourly"
      },
      "last_name": "Bloggs",
      "location_id": 310,
      "note": {
        "author": "Sam Manager",
        "created_at": "2026-10-28T09:00:00Z",
        "text": "Cover the patio.",
        "updated_at": "2026-10-28T09:00:00Z"
      },
      "open": false,
      "published": true,
      "role": "Server",
      "scheduled": true,
      "start_at": "2026-11-03T14:00:00Z",
      "timecard": {
        "approved": false,
        "clock_in": "2026-11-03T13:58:00Z",
        "clock_out": "2026-11-03T22:05:00Z",
        "created_at": "2026-11-03T13:58:00Z",
        "department": "Front of house",
        "first_name": "Jo",
        "id": 77001,
        "job_id": 6620,
        "labor": {
          "break_penalty": 0.0,
          "cash_tips": 20.0,
          "costs": 120.13,
          "credit_tips": 0.0,
          "daily_overtime": 0.0,
          "double_overtime": 0.0,
          "paid_hours": 7.75,
          "paid_time_off_hours": 0.0,
          "regular_hours": 7.75,
          "scheduled_hours": 8.0,
          "seventh_day_overtime_15": 0.0,
          "seventh_day_overtime_20": 0.0,
          "time_off_hours": 0.0,
          "unpaid_break_hours": 0.5,
          "wage_rate": 15.5,
          "wage_type": "hourly",
          "weekly_overtime": 0.0
        },
        "last_name": "Bloggs",
        "payroll_id": "E-102",
        "role": "Server",
        "shift_id": 98001,
        "timebreaks": [
          {
            "created_at": "2026-11-03T18:00:00Z",
            "duration": 30,
            "end_at": "2026-11-03T18:30:00Z",
            "id": 501,
            "mandated_break_id": 12,
            "paid": false,
            "start_at": "2026-11-03T18:00:00Z",
            "timecard_id": 77001,
            "updated_at": "2026-11-03T18:30:00Z",
            "work_period": 300
          }
        ],
        "updated_at": "2026-11-03T22:05:00Z",
        "user_id": 4521
      },
      "timecard_id": 77001,
      "updated_at": "2026-10-28T09:00:00Z",
      "user_id": 4521,
      "wage_rate": 15.5
    },
    "early_in_min": 10,
    "job": {
      "archived_at": null,
      "default_role": "Server",
      "level": "Employee",
      "location_uuid": "f9e46145-b6b1-4e9e-92a0-320510e2c1f3",
      "payroll_id": "E-102",
      "pin": "1234",
      "pos_partner_id": null,
      "roles": [
        {
          "name": "Server",
          "wage_rate": 15.5
        }
      ],
      "wage_rate": 15.5,
      "wage_type": "hourly"
    },
    "mandated_breaks": [
      {
        "duration": 30,
        "id": 12,
        "paid": false,
        "work_period": 300
      }
    ],
    "prevent_early_break_clock_in_enabled": false,
    "prevent_early_clock_in_enabled": true,
    "shift_feedback_enabled": false,
    "shifts": [
      {
        "created_at": "2026-10-28T09:00:00Z",
        "department": "Front of house",
        "end_at": "2026-11-03T22:00:00Z",
        "first_name": "Jo",
        "id": 98001,
        "job_id": 6620,
        "labor": {
          "scheduled_blue_laws_hours": 0.0,
          "scheduled_costs": 116.25,
          "scheduled_daily_overtime": 0.0,
          "scheduled_double_overtimes": 0.0,
          "scheduled_hours": 8.0,
          "scheduled_overtime": 0.0,
          "scheduled_overtime_costs": 0.0,
          "scheduled_regular": 8.0,
          "scheduled_seventh_day_overtime_15": 0.0,
          "scheduled_seventh_day_overtime_20": 0.0,
          "scheduled_spread_of_hours": 0.0,
          "scheduled_unpaid_breaks_hours": 0.5,
          "scheduled_weekly_overtime": 0.0,
          "wage_type": "hourly"
        },
        "last_name": "Bloggs",
        "location_id": 310,
        "note": {
          "author": "Sam Manager",
          "created_at": "2026-10-28T09:00:00Z",
          "text": "Cover the patio.",
          "updated_at": "2026-10-28T09:00:00Z"
        },
        "open": false,
        "published": true,
        "role": "Server",
        "scheduled": true,
        "start_at": "2026-11-03T14:00:00Z",
        "timecard_id": 77001,
        "updated_at": "2026-10-28T09:00:00Z",
        "user_id": 4521,
        "wage_rate": 15.5
      }
    ],
    "status": "clocked_in",
    "tardy_in_min": 5
  }
}

List deleted shifts

List shifts removed from a location's schedule in a period: each shift's id, its times and when it was deleted.

Inputs

Locationlocation_uuidtextRequired
The Homebase location. Pick one, or give its id from an earlier step.
Fromstart_datedate and time
Start of the period. Leave empty for 14 days ago (or four weeks before 'Until').
Untilend_datedate and time
End of the period. Leave empty for 14 days from now (or four weeks after 'From').

Outputs

countnumber
How many were returned
deleted_shiftslist
The deleted shifts
end_datetext
End of the period read (UTC)
start_datetext
Start of the period read (UTC)
totalnumber
How many Homebase has in all
truncatedtrue/false
True if there were more than 5,000 and the rest were not read
Example output
{
  "count": 1,
  "deleted_shifts": [
    {
      "deleted_at": "2026-11-02T10:00:00Z",
      "end_at": "2026-11-04T22:00:00Z",
      "shift_id": 98002,
      "start_at": "2026-11-04T14:00:00Z"
    }
  ],
  "end_date": "2026-11-08T00:00:00Z",
  "start_date": "2026-11-01T00:00:00Z",
  "total": 1,
  "truncated": false
}

List deleted timecards

List timecards deleted at a location in a period: each one's id, clock times and when it was deleted.

Inputs

Locationlocation_uuidtextRequired
The Homebase location. Pick one, or give its id from an earlier step.
Fromstart_datedate and time
Start of the period. Leave empty for 14 days ago (or four weeks before 'Until').
Untilend_datedate and time
End of the period. Leave empty for 14 days from now (or four weeks after 'From').

Outputs

countnumber
How many were returned
deleted_timecardslist
The deleted timecards
end_datetext
End of the period read (UTC)
start_datetext
Start of the period read (UTC)
totalnumber
How many Homebase has in all
truncatedtrue/false
True if there were more than 5,000 and the rest were not read
Example output
{
  "count": 1,
  "deleted_timecards": [
    {
      "clock_in": "2026-11-02T14:00:00Z",
      "clock_out": "2026-11-02T20:00:00Z",
      "deleted_at": "2026-11-03T09:00:00Z",
      "timecard_id": 77002
    }
  ],
  "end_date": "2026-11-08T00:00:00Z",
  "start_date": "2026-11-01T00:00:00Z",
  "total": 1,
  "truncated": false
}

List employees

List a location's employees with their contact details, role, wage and payroll id.

Inputs

Locationlocation_uuidtextRequired
The Homebase location. Pick one, or give its id from an earlier step.
Include archived employeeswith_archivedtrue/false
Also include employees who have been archived (no longer on the team).

Outputs

countnumber
How many were returned
employeeslist
The employees
totalnumber
How many Homebase has in all
truncatedtrue/false
True if there were more than 5,000 and the rest were not read
Example output
{
  "count": 1,
  "employees": [
    {
      "created_at": "2026-01-10T15:00:00Z",
      "email": "jo@example.com",
      "first_name": "Jo",
      "id": 4521,
      "job": {
        "archived_at": null,
        "default_role": "Server",
        "level": "Employee",
        "location_uuid": "f9e46145-b6b1-4e9e-92a0-320510e2c1f3",
        "payroll_id": "E-102",
        "pin": "1234",
        "pos_partner_id": null,
        "roles": [
          {
            "name": "Server",
            "wage_rate": 15.5
          }
        ],
        "wage_rate": 15.5,
        "wage_type": "hourly"
      },
      "last_name": "Bloggs",
      "phone": "5555550100",
      "updated_at": "2026-10-01T15:00:00Z"
    }
  ],
  "total": 1,
  "truncated": false
}

List locations

List your business's locations with their address and time zone.

Inputs

None.

Outputs

countnumber
How many were returned
locationslist
The locations
Example output
{
  "count": 1,
  "locations": [
    {
      "address_1": "1 Main Street",
      "address_2": null,
      "city": "Springfield",
      "country_code": "US",
      "created_at": "2025-06-01T12:00:00Z",
      "name": "Main Street Cafe",
      "partner_merchant_id": null,
      "phone": "5555550199",
      "state": "IL",
      "time_zone": "America/Chicago",
      "updated_at": "2026-09-01T12:00:00Z",
      "uuid": "f9e46145-b6b1-4e9e-92a0-320510e2c1f3",
      "website": "https://example.com",
      "zip": "62701"
    }
  ]
}

List shifts

List a location's scheduled shifts in a period, with who works them, their role and the scheduled hours and cost.

Inputs

Locationlocation_uuidtextRequired
The Homebase location. Pick one, or give its id from an earlier step.
Fromstart_datedate and time
Start of the period. Leave empty for 7 days ago (or two weeks before 'Until').
Untilend_datedate and time
End of the period. Leave empty for 14 days from now (or two weeks after 'From').
Period applies todate_filtertext
Which date must fall in the period. Defaults to the shift's start.One of: start_at (Shift start (default)), end_at (Shift end), created_at (When it was added), updated_at (When it was last changed).
Open shifts onlyopen_onlytrue/false
Only shifts nobody is assigned to yet, which anyone can claim.
Include shift noteswith_notetrue/false
Also return the note added to each shift, with its author.

Outputs

countnumber
How many were returned
end_datetext
End of the period read (UTC)
shiftslist
The shifts
start_datetext
Start of the period read (UTC)
totalnumber
How many Homebase has in all
truncatedtrue/false
True if there were more than 5,000 and the rest were not read
Example output
{
  "count": 1,
  "end_date": "2026-11-08T00:00:00Z",
  "shifts": [
    {
      "created_at": "2026-10-28T09:00:00Z",
      "department": "Front of house",
      "end_at": "2026-11-03T22:00:00Z",
      "first_name": "Jo",
      "id": 98001,
      "job_id": 6620,
      "labor": {
        "scheduled_blue_laws_hours": 0.0,
        "scheduled_costs": 116.25,
        "scheduled_daily_overtime": 0.0,
        "scheduled_double_overtimes": 0.0,
        "scheduled_hours": 8.0,
        "scheduled_overtime": 0.0,
        "scheduled_overtime_costs": 0.0,
        "scheduled_regular": 8.0,
        "scheduled_seventh_day_overtime_15": 0.0,
        "scheduled_seventh_day_overtime_20": 0.0,
        "scheduled_spread_of_hours": 0.0,
        "scheduled_unpaid_breaks_hours": 0.5,
        "scheduled_weekly_overtime": 0.0,
        "wage_type": "hourly"
      },
      "last_name": "Bloggs",
      "location_id": 310,
      "note": {
        "author": "Sam Manager",
        "created_at": "2026-10-28T09:00:00Z",
        "text": "Cover the patio.",
        "updated_at": "2026-10-28T09:00:00Z"
      },
      "open": false,
      "published": true,
      "role": "Server",
      "scheduled": true,
      "start_at": "2026-11-03T14:00:00Z",
      "timecard_id": 77001,
      "updated_at": "2026-10-28T09:00:00Z",
      "user_id": 4521,
      "wage_rate": 15.5
    }
  ],
  "start_date": "2026-11-01T00:00:00Z",
  "total": 1,
  "truncated": false
}

List timecards

List a location's timecards in a period: clock-in and clock-out times, breaks, hours, tips and whether a manager approved them. Time off shows as zero here; use 'Get labor by employee' for it.

Inputs

Locationlocation_uuidtextRequired
The Homebase location. Pick one, or give its id from an earlier step.
Fromstart_datedate and time
Start of the period. Leave empty for 14 days ago (or two weeks before 'Until').
Untilend_datedate and time
End of the period. Leave empty for now (or two weeks after 'From').
Period applies todate_filtertext
Which date must fall in the period. Defaults to the clock-in time.One of: clock_in (Clock-in time (default)), clock_out (Clock-out time), created_at (When it was added), updated_at (When it was last changed).

Outputs

countnumber
How many were returned
end_datetext
End of the period read (UTC)
start_datetext
Start of the period read (UTC)
timecardslist
The timecards
totalnumber
How many Homebase has in all
truncatedtrue/false
True if there were more than 5,000 and the rest were not read
Example output
{
  "count": 1,
  "end_date": "2026-11-08T00:00:00Z",
  "start_date": "2026-11-01T00:00:00Z",
  "timecards": [
    {
      "approved": false,
      "clock_in": "2026-11-03T13:58:00Z",
      "clock_out": "2026-11-03T22:05:00Z",
      "created_at": "2026-11-03T13:58:00Z",
      "department": "Front of house",
      "first_name": "Jo",
      "id": 77001,
      "job_id": 6620,
      "labor": {
        "break_penalty": 0.0,
        "cash_tips": 20.0,
        "costs": 120.13,
        "credit_tips": 0.0,
        "daily_overtime": 0.0,
        "double_overtime": 0.0,
        "paid_hours": 7.75,
        "paid_time_off_hours": 0.0,
        "regular_hours": 7.75,
        "scheduled_hours": 8.0,
        "seventh_day_overtime_15": 0.0,
        "seventh_day_overtime_20": 0.0,
        "time_off_hours": 0.0,
        "unpaid_break_hours": 0.5,
        "wage_rate": 15.5,
        "wage_type": "hourly",
        "weekly_overtime": 0.0
      },
      "last_name": "Bloggs",
      "payroll_id": "E-102",
      "role": "Server",
      "shift_id": 98001,
      "timebreaks": [
        {
          "created_at": "2026-11-03T18:00:00Z",
          "duration": 30,
          "end_at": "2026-11-03T18:30:00Z",
          "id": 501,
          "mandated_break_id": 12,
          "paid": false,
          "start_at": "2026-11-03T18:00:00Z",
          "timecard_id": 77001,
          "updated_at": "2026-11-03T18:30:00Z",
          "work_period": 300
        }
      ],
      "updated_at": "2026-11-03T22:05:00Z",
      "user_id": 4521
    }
  ],
  "total": 1,
  "truncated": false
}

On this page