> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.hellotracks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List timesheet entries

> Lists clock-in/clock-out entries of the company's members for one day (default today) or a from/until range, with totals. Days are in the caller's time zone; an entry belongs to the day it starts. There is no paging and no limit on the range. Admins, operators and the company key may call it; workers get 403.



## OpenAPI

````yaml v1/openapi.json GET /timesheets
openapi: 3.1.0
info:
  title: Hellotracks REST API
  version: '1'
  description: >-
    Plain REST resources over HTTPS, for tools, automations and services. The ht
    command line is built on it.
  contact:
    email: api@hellotracks.com
servers:
  - url: https://api.hellotracks.com/v1
security:
  - ApiKey: []
tags:
  - name: Sign-up and sign-in
    description: >-
      Create a company or get an API key by an emailed code, without a key; and
      check which account a key belongs to.
  - name: Company
    description: The company the API key belongs to, with its settings and teams.
  - name: Members
    description: 'The people in the company: admins, operators and workers.'
  - name: API keys
    description: 'The company''s API keys: list, create, revoke and delete.'
  - name: Jobs
    description: 'Jobs: work at a location on a date, assigned to a member.'
  - name: Places
    description: 'Places: customer sites and other saved locations with a check-in radius.'
  - name: Zones
    description: 'Zones: the company''s geofences.'
  - name: Routing
    description: Route optimization for one member's day.
  - name: ETA pages
    description: >-
      Live ETA pages (eta.page links) that show a job's recipient when the
      worker arrives.
  - name: Maps
    description: Rendered maps as GeoJSON, and public map share links.
  - name: Timesheets
    description: Clock-in and clock-out entries of members, with totals, and editing them.
  - name: Forms
    description: >-
      Form templates, submitted forms, attachments for file and image fields,
      and forms linked to places and jobs.
  - name: Alerts
    description: >-
      Alert rules (configs) that watch members, places and zones, and the alerts
      (instances) they raised.
  - name: Reports
    description: >-
      Reports: the newer reporting API (catalog, preview, run, saved) and the
      older one (types, generate, jobs, uploads, recurring).
  - name: Webhooks
    description: URLs Hellotracks calls when jobs, check-ins, clock-ins or alerts happen.
paths:
  /timesheets:
    get:
      tags:
        - Timesheets
      summary: List timesheet entries
      description: >-
        Lists clock-in/clock-out entries of the company's members for one day
        (default today) or a from/until range, with totals. Days are in the
        caller's time zone; an entry belongs to the day it starts. There is no
        paging and no limit on the range. Admins, operators and the company key
        may call it; workers get 403.
      operationId: listTimesheets
      parameters:
        - name: date
          in: query
          required: false
          description: One day, YYYY-MM-DD. Use either date or from+until; neither = today.
          schema:
            type: string
            format: date
          example: '2026-10-30'
        - name: from
          in: query
          required: false
          description: First day, YYYY-MM-DD; needs until.
          schema:
            type: string
            format: date
        - name: until
          in: query
          required: false
          description: Last day, YYYY-MM-DD, inclusive.
          schema:
            type: string
            format: date
        - name: memberId
          in: query
          required: false
          description: Only this member.
          schema:
            type: string
          example: a1b2c3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                properties:
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          $ref: '#/components/schemas/TimesheetEntry'
                      summary:
                        type: object
                        properties:
                          totalSeconds:
                            type: integer
                            format: int64
                          entryCount:
                            type: integer
                          openEntryCount:
                            type: integer
                          memberCount:
                            type: integer
              example:
                data:
                  items:
                    - id: 650000000000000000000011_650000000000000000000012
                      member:
                        id: a1b2c3
                        name: Driver 1
                        username: driver1@example.com
                        email: driver1@example.com
                      date: '2026-10-30'
                      clockIn:
                        id: '650000000000000000000011'
                        timestamp: 1761832800000
                        time: '07:00'
                        type: 1
                        isClockIn: true
                      clockOut:
                        id: '650000000000000000000012'
                        timestamp: 1761863400000
                        time: '15:30'
                        type: -1
                        isClockIn: false
                      durationSeconds: 30600
                      open: false
                  summary:
                    totalSeconds: 30600
                    entryCount: 1
                    openEntryCount: 0
                    memberCount: 1
                error: null
                meta:
                  path: /v1/timesheets
                  method: GET
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    Envelope:
      type: object
      properties:
        data:
          description: The payload.
        error:
          type: 'null'
        meta:
          $ref: '#/components/schemas/Meta'
    TimesheetEntry:
      type: object
      description: A clock-in with its clock-out. Either side can be missing.
      properties:
        id:
          type: string
          description: clockInId_clockOutId; a missing side is "-".
          example: 650000000000000000000011_650000000000000000000012
        member:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            username:
              type: string
            email:
              type: string
        date:
          type: string
          format: date
          description: YYYY-MM-DD in the caller's time zone.
        clockIn:
          oneOf:
            - $ref: '#/components/schemas/TimesheetClock'
            - type: 'null'
        clockOut:
          oneOf:
            - $ref: '#/components/schemas/TimesheetClock'
            - type: 'null'
        durationSeconds:
          type: integer
          format: int64
        open:
          type: boolean
          description: true when there is no clock-out yet.
    Meta:
      type: object
      properties:
        path:
          type: string
          description: The request path, without /v1.
          example: /jobs
        method:
          type: string
          example: GET
    TimesheetClock:
      type: object
      properties:
        id:
          type: string
          description: Clock record id (24 hex characters).
        timestamp:
          type: integer
          format: int64
          description: Milliseconds since the epoch.
        time:
          type: string
          description: HH:mm in the caller's time zone.
        type:
          type: integer
          enum:
            - 1
            - 2
            - -1
            - -2
          description: >-
            1 login, 2 tracking on (clock-ins); -1 logout, -2 tracking off
            (clock-outs).
        isClockIn:
          type: boolean
    ErrorEnvelope:
      type: object
      properties:
        data:
          type: 'null'
        error:
          $ref: '#/components/schemas/Error'
        meta:
          $ref: '#/components/schemas/Meta'
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Stable error code for programs.
          enum:
            - invalid_request
            - invalid_format
            - invalid_data
            - invalid_api_key
            - unknown_user
            - authentication_failed
            - forbidden
            - not_found
            - already_exists
            - throttled
            - not_ready
            - clock_invalid
            - force_logout
            - internal_error
            - unknown_error
        message:
          type: string
          description: Why it failed, for people.
  responses:
    BadRequest:
      description: The request is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            data: null
            error:
              code: invalid_request
              message: date must be YYYY-MM-DD
            meta:
              path: /jobs
              method: GET
    Unauthorized:
      description: The API key is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            data: null
            error:
              code: invalid_api_key
              message: Invalid Hellotracks API key.
            meta:
              path: /jobs
              method: GET
    Forbidden:
      description: The key may not do this.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            data: null
            error:
              code: forbidden
              message: No permission.
            meta:
              path: /jobs
              method: GET
    TooManyRequests:
      description: Too many requests; slow down.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            data: null
            error:
              code: throttled
              message: Too many requests.
            meta:
              path: /jobs
              method: GET
    ServerError:
      description: Hellotracks failed; retry later.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            data: null
            error:
              code: internal_error
              message: Hellotracks API is temporarily unavailable.
            meta:
              path: /jobs
              method: GET
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: API-Key
      description: >-
        Your API key, from More → API & Integrations in the dashboard, or from
        ht signup / ht auth login.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.