# Homebase

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

App · 16 actions. Web page: https://docs.lodol.com/docs/integrations/homebase

## Actions

### Get company

Get your Homebase company's name and its owner.

**Inputs**: None.

**Outputs**

- `company` (object): The company

**Example output**

```json
{
  "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**

- Location (`location_uuid`, text, required): The Homebase location. Pick one, or give its id from an earlier step.
- Employee (`employee_id`, text, required): The employee. Pick one, or give their id from an earlier step.
- Include archived employees (`with_archived`, true/false): Also include employees who have been archived (no longer on the team).

**Outputs**

- `employee` (object): The employee

**Example output**

```json
{
  "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**

- Location (`location_uuid`, text, required): The Homebase location. Pick one, or give its id from an earlier step.
- From (`start_date`, date and time): Start of the period. Leave empty for 7 days ago (or a week before 'Until').
- Until (`end_date`, date and time): End of the period. Leave empty for now (or a week after 'From').

**Outputs**

- `count` (number): How many were returned
- `employees` (list): The totals for each employee
- `end_date` (text): End of the period read (UTC)
- `start_date` (text): Start of the period read (UTC)

**Example output**

```json
{
  "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**

- Location (`location_uuid`, text, required): The Homebase location. Pick one, or give its id from an earlier step.
- From (`start_date`, date and time): Start of the period. Leave empty for 7 days ago (or a week before 'Until').
- Until (`end_date`, date and time): End of the period. Leave empty for now (or a week after 'From').

**Outputs**

- `count` (number): How many were returned
- `end_date` (text): End of the period read (UTC)
- `roles` (list): The totals for each role
- `start_date` (text): Start of the period read (UTC)

**Example output**

```json
{
  "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**

- Location (`location_uuid`, text, required): The Homebase location. Pick one, or give its id from an earlier step.
- From (`start_date`, date and time): Start of the period. Leave empty for 7 days ago (or a week before 'Until').
- Until (`end_date`, date and time): End of the period. Leave empty for now (or a week after 'From').
- Group (`group_by`, text): Totals for each day or for each hour. Defaults to each day. One of: `day` (By day (default)), `hour` (By hour).

**Outputs**

- `count` (number): How many were returned
- `end_date` (text): End of the period read (UTC)
- `labor` (list): The totals, one per day or hour
- `start_date` (text): Start of the period read (UTC)

**Example output**

```json
{
  "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**

- Location (`location_uuid`, text, required): The Homebase location. Pick one, or give its id from an earlier step.

**Outputs**

- `location` (object): The location

**Example output**

```json
{
  "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**

- Location (`location_uuid`, text, required): The Homebase location. Pick one, or give its id from an earlier step.

**Outputs**

- `plan` (object): The location's plan

**Example output**

```json
{
  "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**

- Location (`location_uuid`, text, required): The Homebase location. Pick one, or give its id from an earlier step.
- Shift ID (`shift_id`, number, required): The shift's id, from 'List shifts' or an earlier step.
- Include shift notes (`with_note`, true/false): Also return the note added to each shift, with its author.

**Outputs**

- `shift` (object): The shift

**Example output**

```json
{
  "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**

- Location (`location_uuid`, text, required): The Homebase location. Pick one, or give its id from an earlier step.
- Timecard ID (`timecard_id`, number, required): The timecard's id, from 'List timecards' or an earlier step.

**Outputs**

- `timecard` (object): The timecard

**Example output**

```json
{
  "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 ID (`job_id`, number, required): The employee's job id at the location: the job_id on one of their shifts or timecards.

**Outputs**

- `timeclock` (object): The timeclock status

**Example output**

```json
{
  "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**

- Location (`location_uuid`, text, required): The Homebase location. Pick one, or give its id from an earlier step.
- From (`start_date`, date and time): Start of the period. Leave empty for 14 days ago (or four weeks before 'Until').
- Until (`end_date`, date and time): End of the period. Leave empty for 14 days from now (or four weeks after 'From').

**Outputs**

- `count` (number): How many were returned
- `deleted_shifts` (list): The deleted shifts
- `end_date` (text): End of the period read (UTC)
- `start_date` (text): Start of the period read (UTC)
- `total` (number): How many Homebase has in all
- `truncated` (true/false): True if there were more than 5,000 and the rest were not read

**Example output**

```json
{
  "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**

- Location (`location_uuid`, text, required): The Homebase location. Pick one, or give its id from an earlier step.
- From (`start_date`, date and time): Start of the period. Leave empty for 14 days ago (or four weeks before 'Until').
- Until (`end_date`, date and time): End of the period. Leave empty for 14 days from now (or four weeks after 'From').

**Outputs**

- `count` (number): How many were returned
- `deleted_timecards` (list): The deleted timecards
- `end_date` (text): End of the period read (UTC)
- `start_date` (text): Start of the period read (UTC)
- `total` (number): How many Homebase has in all
- `truncated` (true/false): True if there were more than 5,000 and the rest were not read

**Example output**

```json
{
  "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**

- Location (`location_uuid`, text, required): The Homebase location. Pick one, or give its id from an earlier step.
- Include archived employees (`with_archived`, true/false): Also include employees who have been archived (no longer on the team).

**Outputs**

- `count` (number): How many were returned
- `employees` (list): The employees
- `total` (number): How many Homebase has in all
- `truncated` (true/false): True if there were more than 5,000 and the rest were not read

**Example output**

```json
{
  "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**

- `count` (number): How many were returned
- `locations` (list): The locations

**Example output**

```json
{
  "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**

- Location (`location_uuid`, text, required): The Homebase location. Pick one, or give its id from an earlier step.
- From (`start_date`, date and time): Start of the period. Leave empty for 7 days ago (or two weeks before 'Until').
- Until (`end_date`, date and time): End of the period. Leave empty for 14 days from now (or two weeks after 'From').
- Period applies to (`date_filter`, text): 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 only (`open_only`, true/false): Only shifts nobody is assigned to yet, which anyone can claim.
- Include shift notes (`with_note`, true/false): Also return the note added to each shift, with its author.

**Outputs**

- `count` (number): How many were returned
- `end_date` (text): End of the period read (UTC)
- `shifts` (list): The shifts
- `start_date` (text): Start of the period read (UTC)
- `total` (number): How many Homebase has in all
- `truncated` (true/false): True if there were more than 5,000 and the rest were not read

**Example output**

```json
{
  "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**

- Location (`location_uuid`, text, required): The Homebase location. Pick one, or give its id from an earlier step.
- From (`start_date`, date and time): Start of the period. Leave empty for 14 days ago (or two weeks before 'Until').
- Until (`end_date`, date and time): End of the period. Leave empty for now (or two weeks after 'From').
- Period applies to (`date_filter`, text): 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**

- `count` (number): How many were returned
- `end_date` (text): End of the period read (UTC)
- `start_date` (text): Start of the period read (UTC)
- `timecards` (list): The timecards
- `total` (number): How many Homebase has in all
- `truncated` (true/false): True if there were more than 5,000 and the rest were not read

**Example output**

```json
{
  "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
}
```
