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

# Page recorded time entries

> Effective corrected intervals, including custom activities and validated work links. Orders by created_at then id ascending. Soft-deleted entries require include_deleted=true. No reliable updated_since filter; refresh known IDs and effective-start windows. Elapsed duration is distinct from capped timesheet minutes.



## OpenAPI

````yaml /openapi.json get /time-entries
openapi: 3.0.3
info:
  title: Breezy Public Reporting API
  version: 1.0.0
  description: >-
    Read customers, team members, jobs, visits, assignments, installed
    equipment, captured form responses, time entries, configured-period
    timesheets, business reference catalogs, job leads, estimates, invoices,
    payments, refunds, recorded job financials, saved sold/earned credits, and
    financial summaries for your company. Existing API keys grant company-wide
    read access. Amounts are integer USD cents. Reads return current corrected
    records, with cursor pagination for collecting results.


    Read the [Breezy FSM guides](https://developers.getbreezyapp.com) for
    authentication, pagination, refresh limits, and business measures. All reads
    use latest corrected company records; cursors do not create a snapshot or a
    complete change feed.
servers:
  - url: https://api.getbreezyapp.com/v1
    description: Breezy FSM production API
security:
  - apiKey: []
tags:
  - name: Company
  - name: Invoices
  - name: Payments
  - name: Refunds
  - name: Reports
  - name: TeamMembers
  - name: Accounts
  - name: Contacts
  - name: Locations
  - name: Jobs
  - name: JobAppointments
  - name: JobAssignments
  - name: BusinessUnits
  - name: JobTypes
  - name: JobClasses
  - name: JobLifecycles
  - name: LeadSources
  - name: Tags
  - name: Estimates
  - name: JobLeads
  - name: Equipment
  - name: FormResponses
  - name: TimeEntries
  - name: Timesheets
  - name: JobFinancials
  - name: RevenueAttributions
externalDocs:
  description: Breezy FSM reporting guides and API reference
  url: https://developers.getbreezyapp.com
paths:
  /time-entries:
    get:
      tags:
        - TimeEntries
      summary: Page recorded time entries
      description: >-
        Effective corrected intervals, including custom activities and validated
        work links. Orders by created_at then id ascending. Soft-deleted entries
        require include_deleted=true. No reliable updated_since filter; refresh
        known IDs and effective-start windows. Elapsed duration is distinct from
        capped timesheet minutes.
      operationId: listTimeEntries
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
            description: >-
              Maximum parent records or report rows. Complete children are
              always included.
          required: false
          description: >-
            Maximum parent records or report rows. Complete children are always
            included.
          name: limit
          in: query
        - schema:
            type: string
            nullable: true
            minLength: 1
            default: null
            description: >-
              Repeat the original filters; any valid page size may continue.
              Foreign-company, tampered or mismatched cursors return
              INVALID_CURSOR.
          required: false
          description: >-
            Repeat the original filters; any valid page size may continue.
            Foreign-company, tampered or mismatched cursors return
            INVALID_CURSOR.
          name: cursor
          in: query
        - schema:
            type: array
            nullable: true
            items:
              type: string
              format: uuid
            minItems: 1
            maxItems: 100
            default: null
            description: >-
              Repeat ids for a bounded ID set. Valid foreign or missing IDs
              contribute no list rows.
          required: false
          style: form
          explode: true
          name: ids
          in: query
        - schema:
            type: string
            nullable: true
            format: date-time
            default: null
            description: Inclusive creation instant.
          required: false
          description: Inclusive creation instant.
          name: created_from
          in: query
        - schema:
            type: string
            nullable: true
            format: date-time
            default: null
            description: Exclusive creation instant.
          required: false
          description: Exclusive creation instant.
          name: created_before
          in: query
        - schema:
            type: string
            nullable: true
            format: uuid
            default: null
          required: false
          name: team_member_id
          in: query
        - schema:
            type: string
            nullable: true
            format: uuid
            default: null
          required: false
          name: job_id
          in: query
        - schema:
            type: string
            nullable: true
            format: uuid
            default: null
          required: false
          name: appointment_id
          in: query
        - schema:
            type: string
            nullable: true
            format: uuid
            default: null
          required: false
          name: assignment_id
          in: query
        - schema:
            type: string
            nullable: true
            format: date-time
            default: null
            description: Inclusive effective start instant.
          required: false
          description: Inclusive effective start instant.
          name: starts_from
          in: query
        - schema:
            type: string
            nullable: true
            format: date-time
            default: null
            description: Exclusive effective start instant; this is not an overlap filter.
          required: false
          description: Exclusive effective start instant; this is not an overlap filter.
          name: starts_before
          in: query
        - schema:
            type: string
            nullable: true
            minLength: 1
            default: null
            description: Exact, case-sensitive recorded activity name.
          required: false
          description: Exact, case-sensitive recorded activity name.
          name: activity_name
          in: query
        - schema:
            type: boolean
            nullable: true
            default: null
          required: false
          name: payable
          in: query
        - schema:
            type: boolean
            nullable: true
            default: null
            description: >-
              True selects entries with no effective end; false selects closed
              entries.
          required: false
          description: >-
            True selects entries with no effective end; false selects closed
            entries.
          name: open
          in: query
        - schema:
            type: boolean
            default: false
            description: >-
              Include retained soft-deleted entries; hard-deleted records are
              unavailable.
          required: false
          description: >-
            Include retained soft-deleted entries; hard-deleted records are
            unavailable.
          name: include_deleted
          in: query
      responses:
        '200':
          description: Successful read. Clients ignore unrecognized response fields.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeEntryPage'
              example:
                data:
                  - id: b1000000-0000-4000-8000-000000000001
                    team_member:
                      id: 11111111-1111-4111-8111-000000000401
                      name: Alex Example
                    starts_at: '2026-09-08T19:30:00Z'
                    ends_at: '2026-09-08T20:30:30Z'
                    start_corrected: false
                    end_corrected: true
                    duration_minutes: 60.5
                    activity:
                      name: ON-SITE
                      kind: ON-SITE
                    payable: true
                    job_id: 11111111-1111-4111-8111-000000000501
                    appointment_id: 11111111-1111-4111-8111-000000001109
                    assignment_id: 11111111-1111-4111-8111-000000001113
                    attention_note: null
                    deleted_at: null
                    created_by:
                      id: 11111111-1111-4111-8111-000000000401
                      name: Alex Example
                    updated_by:
                      id: 11111111-1111-4111-8111-000000000401
                      name: Alex Example
                    deleted_by: null
                    created_at: '2026-09-08T19:30:00Z'
                    updated_at: null
                pagination:
                  next_cursor: null
                meta:
                  request_id: 11111111-1111-4111-8111-000000009999
                  generated_at: '2026-09-08T19:00:00Z'
                  timezone: America/Los_Angeles
        '400':
          description: >-
            Malformed input, unknown query parameter, unsupported combination or
            invalid cursor.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: INVALID_REQUEST
                  message: end_date must be later than start_date
                  request_id: example-request
                  details: []
        '401':
          description: Missing, invalid or expired key, or invalid linked identity.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
            WWW-Authenticate:
              schema:
                type: string
              example: Bearer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: UNAUTHENTICATED
                  message: A valid API key is required
                  request_id: example-request
                  details: []
        '404':
          description: >-
            Missing resource or resource outside the authenticated company. Same
            response for both.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: NOT_FOUND
                  message: Resource not found
                  request_id: example-request
                  details: []
        '405':
          description: Write methods do not mutate business data and return 405.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
            Allow:
              schema:
                type: string
              example: GET, HEAD, OPTIONS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: METHOD_NOT_ALLOWED
                  message: This resource supports GET
                  request_id: example-request
                  details: []
        '429':
          description: Company request budget exhausted; retry after the indicated delay.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
            Retry-After:
              schema:
                type: integer
                minimum: 1
              description: Seconds before retrying.
              example: 30
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: RATE_LIMITED
                  message: Request limit exceeded
                  request_id: example-request
                  details: []
        '500':
          description: >-
            Unexpected failure. Share request_id with support; no stack or
            provider secrets in response.
          headers:
            Cache-Control:
              schema:
                type: string
              example: private, no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: INTERNAL_ERROR
                  message: Unable to complete request
                  request_id: example-request
                  details: []
      security:
        - apiKey: []
components:
  schemas:
    TimeEntryPage:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TimeEntry'
        pagination:
          $ref: '#/components/schemas/Pagination'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      required:
        - data
        - pagination
        - meta
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - INVALID_REQUEST
                - INVALID_CURSOR
                - UNAUTHENTICATED
                - NOT_FOUND
                - METHOD_NOT_ALLOWED
                - RATE_LIMITED
                - INTERNAL_ERROR
            message:
              type: string
            request_id:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - field
                  - message
          required:
            - code
            - message
            - request_id
            - details
      required:
        - error
    TimeEntry:
      type: object
      properties:
        id:
          type: string
          format: uuid
        team_member:
          $ref: '#/components/schemas/Reference'
        starts_at:
          type: string
          format: date-time
          description: >-
            Effective start: recorded correction when present, otherwise
            original start.
        ends_at:
          type: string
          nullable: true
          format: date-time
          description: Effective end; null means the entry remains open.
        start_corrected:
          type: boolean
        end_corrected:
          type: boolean
        duration_minutes:
          type: number
          nullable: true
          description: >-
            Elapsed effective minutes, including fractions and overnight time;
            null for open entries. Not capped timesheet payable minutes.
        activity:
          type: object
          nullable: true
          properties:
            name:
              type: string
              description: Recorded name, including custom activity names.
            kind:
              type: string
              enum:
                - IDLE
                - DRIVE-TIME
                - ON-SITE
                - LUNCH
                - CUSTOM
          required:
            - name
            - kind
          description: Null when a single company-owned activity cannot be established.
        payable:
          type: boolean
          nullable: true
          description: >-
            Recorded payable flag, independent of activity name; null when
            activity is unavailable or ambiguous.
        job_id:
          type: string
          nullable: true
          format: uuid
        appointment_id:
          type: string
          nullable: true
          format: uuid
        assignment_id:
          type: string
          nullable: true
          format: uuid
        attention_note:
          type: string
          nullable: true
        deleted_at:
          type: string
          nullable: true
          format: date-time
        created_by:
          $ref: '#/components/schemas/NullableReference'
        updated_by:
          $ref: '#/components/schemas/NullableReference'
        deleted_by:
          $ref: '#/components/schemas/NullableReference'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          description: >-
            Unavailable: existing entry edits and work-link changes do not
            reliably maintain a modification timestamp. Refresh bounded
            effective-start windows.
          nullable: true
          enum:
            - null
      required:
        - id
        - team_member
        - starts_at
        - ends_at
        - start_corrected
        - end_corrected
        - duration_minutes
        - activity
        - payable
        - job_id
        - appointment_id
        - assignment_id
        - attention_note
        - deleted_at
        - created_by
        - updated_by
        - deleted_by
        - created_at
        - updated_at
    Pagination:
      type: object
      properties:
        next_cursor:
          type: string
          nullable: true
          description: >-
            Opaque continuation. Null ends traversal. Keep the same filters;
            page size may change.
      required:
        - next_cursor
    ResponseMeta:
      type: object
      properties:
        request_id:
          type: string
        generated_at:
          type: string
          format: date-time
        timezone:
          type: string
      required:
        - request_id
        - generated_at
        - timezone
      description: >-
        Generation time and company timezone. generated_at is not a snapshot or
        synchronization token.
    Reference:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
      required:
        - id
        - name
    NullableReference:
      type: object
      nullable: true
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
      required:
        - id
        - name
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Existing Breezy API key. Grants all published reads in its associated
        company. No app permission scopes.

````