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

# List Time Trackings

> Filter and retrieve time tracking entries based on various criteria including user, date range, object, and activity type. Supports pagination and sorting.



## OpenAPI

````yaml GET /timetracking/list
openapi: 3.0.0
info:
  title: PlanD API
  description: PlanD Public API
  version: '2'
servers:
  - url: http:localhost:3000/v2
    description: Local Server
  - url: https://beta-api.pland.app/v2
    description: Sandbox Server
  - url: https://cloud-api.pland.app/v2
    description: Production Server
security: []
tags:
  - name: Absences
    description: >-
      Absence management endpoints for creating, updating, and managing user
      absences
  - name: Activity Types
    description: Activity type management operations
  - name: API Keys
    description: API key management operations for programmatic access to the API
  - name: Assignments
    description: Assignment management operations
  - name: Chat (Legacy)
    description: >-
      Legacy chat operations using Stream Chat service (deprecated - use Entity
      Chat v2 instead)
  - name: Client
    description: Unauthenticated client-facing operations
  - name: Company
    description: Company information and settings management operations
  - name: Complaints
    description: Customer complaint and ticket management operations
  - name: Contacts
    description: Contact person management operations
  - name: Customers
    description: Customer management operations
  - name: Customer Objects
    description: >-
      Customer object management operations - locations and buildings where
      services are performed
  - name: Documents
    description: >-
      Document management operations for uploading, retrieving, and managing
      files
  - name: Logbuch
    description: >-
      Operations for sending, retrieving, updating, and deleting Logbuch in
      entity chats.
  - name: Push Notifications
    description: Operations for listing, reading, and deleting user notifications.
  - name: Equipment
    description: Equipment management operations
  - name: Equipment Types
    description: Equipment type management operations
  - name: Assignment Confirmations
    description: Assignment confirmation management operations
  - name: Credit
    description: >-
      Credit note management operations for creating and handling credit
      documents
  - name: Invoice
    description: >-
      Invoice management operations for creating, managing, and processing
      customer invoices
  - name: Invoice Reminders
    description: >-
      Invoice reminder management operations for creating and handling payment
      reminder documents
  - name: Invoice Reminder Templates
    description: >-
      Invoice reminder template management operations for creating and handling
      reminder document templates
  - name: Invoice Storno
    description: Invoice storno (cancellation) document management operations
  - name: Invoice Templates
    description: >-
      Invoice template management operations for creating and handling invoice
      document templates
  - name: Offers
    description: Offer management operations
  - name: ServiceReport
    description: >-
      Service report management operations for creating and handling service
      documentation
  - name: Holiday
    description: Holidays management
  - name: Implementation
    description: User implementation progress tracking and onboarding management
  - name: Jobs
    description: >-
      Endpoints for managing jobs, including creation, listing, updating, and
      job-specific actions.
  - name: Material Orders
    description: Operations for listing, viewing, updating, and managing material orders.
  - name: Notifications
    description: User notification management operations
  - name: Payment Methods
    description: >-
      Payment method management operations for configuring available payment
      options
  - name: Payment Terms
    description: Operations for managing payment terms
  - name: Payments
    description: Payment management operations
  - name: Articles
    description: >-
      Operations for creating, listing, viewing, updating, and deleting
      articles.
  - name: Suppliers
    description: Supplier management operations
  - name: Service Products
    description: >-
      Operations for creating, listing, viewing, updating, and deleting service
      products.
  - name: Quality Control
    description: Quality control and assessment management operations
  - name: Pay Types
    description: Pay type management operations for salary and absence types
  - name: Salary
    description: >-
      Salary management operations for tracking and managing employee
      compensation
  - name: Surcharges
    description: Surcharge management operations for pay types and salary calculations
  - name: Search
    description: Search for entities in PlanD
  - name: Signing
    description: Endpoints for creating and listing signings (digital signatures).
  - name: Tasks
    description: Task management operations
  - name: Task Types
    description: Task type management operations
  - name: Tax Rates
    description: >-
      Tax rate management operations for handling VAT, zero rates, exemptions,
      and reverse charge scenarios
  - name: Time Tracking
    description: >-
      Time tracking management endpoints for recording, monitoring, and managing
      work time entries
  - name: Assets
    description: Asset URL management operations for secure access to uploaded files
  - name: Upload
    description: >-
      CSV and file uploads for various entities (articles, material, users,
      customers, objects, contacts, equipment, images)
  - name: Users
    description: >-
      User management endpoints for creating, updating, and managing system
      users
  - name: Authentication
    description: User authentication and password management operations
  - name: Banking Transactions
    description: Banking transaction management operations
  - name: Webhooks
  - name: SMS
    description: Endpoints for SMS status updates and link tracking.
paths:
  /timetracking/list:
    get:
      tags:
        - Time Tracking
      summary: Filter time tracking entries
      description: >-
        Filter and retrieve time tracking entries based on various criteria
        including user, date range, object, and activity type. Supports
        pagination and sorting.
      operationId: filterTimeTrackings
      parameters:
        - name: limit
          in: query
          description: Maximum number of entries to return
          required: false
          schema:
            type: integer
            default: 50
            maximum: 500
        - name: offset
          in: query
          description: Number of entries to skip for pagination
          required: false
          schema:
            type: integer
            default: 0
            minimum: 0
        - name: sort
          in: query
          description: Field to sort by
          required: false
          schema:
            type: string
            default: timeStart
        - name: userId
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterUser'
        - name: from
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterFrom'
        - name: to
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterTo'
        - name: objectId
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterObject'
        - name: activityTypeId
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterActivityTypeId'
        - name: status
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterStatus'
        - name: timeTrackingNotApproved
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/FilterNotApproved'
      responses:
        '200':
          description: Time tracking entries retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TimeTrackingEntry'
        '400':
          description: Invalid filter parameters
        '401':
          description: Unauthorized - Authentication required
        '500':
          description: Internal server error
      security:
        - API-Key: []
        - Bearer-Auth: []
components:
  schemas:
    FilterUser:
      description: Filter by user ID
      type: string
      format: objectid
      x-internal: true
    FilterFrom:
      description: Filter by creation date from (timestamp)
      type: integer
      format: int64
      x-internal: true
    FilterTo:
      description: Filter by creation date to (timestamp)
      type: integer
      format: int64
      x-internal: true
    FilterObject:
      description: Filter by object ID
      type: string
      format: objectid
      x-internal: true
    FilterActivityTypeId:
      title: Filter for Activity Type ID
      description: >-
        Filter to search jobs by activity type IDs. It can handle multiple
        activity type IDs and also includes checks for assignments, jobs, and
        salaries.
      type: array
      items:
        description: Activity Type ID to filter by
        type: string
        format: objectId
      x-internal: true
    FilterStatus:
      description: Filter by status (single value or comma-separated list)
      type: string
      x-internal: true
    FilterNotApproved:
      description: Filter for time tracking entries that are not approved
      type: object
      x-internal: true
    TimeTrackingEntry:
      title: Time Tracking Entry
      description: >-
        A time tracking entry recording work time for a job, including start/end
        times, location data, and status information
      type: object
      allOf:
        - $ref: '#/components/schemas/ChatableEntityModel'
        - properties:
            _id:
              description: Unique identifier for the time tracking entry
              type: string
              format: objectid
            userId:
              description: ID of the user who performed the work
              type: string
              format: objectid
            jobId:
              description: ID of the job being tracked
              type: string
              format: objectid
            objectId:
              description: ID of the customer object/location where work was performed
              type: string
              format: objectid
            timeStart:
              description: Start timestamp of the work period (UTC)
              type: string
              format: date-time
            timeEnd:
              description: End timestamp of the work period (UTC)
              type: string
              format: date-time
            workingTime:
              description: Actual working time in seconds (timeEnd - timeStart - break)
              type: integer
              minimum: 0
            targetTime:
              description: Target/expected working time in seconds
              type: integer
              minimum: 0
            break:
              description: Break time in seconds
              type: integer
              minimum: 0
            requiredBreakTime:
              description: Legally required break time in seconds
              type: integer
              minimum: 0
            type:
              description: Type of time tracking entry
              type: string
              enum:
                - default
                - simple
                - offline
                - driving
                - manual
            location:
              description: GPS coordinates where work started
              properties:
                latitude:
                  type: number
                  format: float
                longitude:
                  type: number
                  format: float
              type: object
            logOutLocation:
              description: GPS coordinates where work ended
              properties:
                latitude:
                  type: number
                  format: float
                longitude:
                  type: number
                  format: float
              type: object
            approved:
              description: Whether the time tracking entry has been approved for billing
              type: boolean
            cancelled:
              description: Whether the time tracking entry has been cancelled
              type: boolean
            offline:
              description: Whether the entry was created while offline
              type: boolean
            generatedByUser:
              description: Whether the entry was manually created by a user
              type: boolean
            editedByManager:
              description: Whether the entry was modified by a manager
              type: boolean
            trackingJobDate:
              description: Date for which the work was scheduled/performed (UTC)
              type: string
              format: date-time
            comment:
              description: Additional comments or notes about the work performed
              type: string
            reason:
              description: Reason for manual time tracking entry creation
              type: string
            errors:
              description: Array of error codes preventing automatic salary release
              type: array
              items:
                type: string
            allFoundErrors:
              description: Array of all detected errors during time tracking validation
              type: array
              items:
                type: string
            salaryIds:
              description: Array of salary IDs created from this time tracking entry
              type: array
              items:
                type: string
                format: objectid
            objectManagerId:
              description: ID of the object manager responsible for this entry
              type: string
              format: objectid
            signingId:
              description: ID of associated signing document
              type: string
              format: objectid
            activityTypeId:
              description: ID of the activity type performed
              type: string
              format: objectid
            assignmentId:
              description: ID of the assignment associated with this time tracking
              type: string
              format: objectid
          type: object
    ChatableEntityModel:
      title: Chatable Entity Model
      description: Base class for all entities that can have a chat associated with them.
      type: object
      allOf:
        - $ref: '#/components/schemas/Entity'
        - properties:
            chatId:
              description: ID of the chat associated with this entity
              type: string
              format: objectid
              nullable: true
          type: object
    Entity:
      title: Entity
      description: >-
        Base class for all entities in the system, providing common properties
        and methods.
      properties:
        _id:
          description: Unique identifier of the entity
          type: string
          format: objectid
        number:
          description: Unique number of the entity, used for identification
          type: integer
        companyId:
          description: The ID of the company this entity belongs to
          type: string
          format: objectid
          x-internal: true
        status:
          $ref: '#/components/schemas/StatusStruct'
      type: object
    StatusStruct:
      description: Entity Status information
      properties:
        status:
          description: Current status
          type: integer
        createdAt:
          description: Creation timestamp
          type: string
          format: date-time
        createdBy:
          description: User who created this supplier
          type: string
          format: objectid
        lastModifiedAt:
          description: Last modification timestamp
          type: string
          format: date-time
        lastModifiedBy:
          description: User who last modified this supplier
          type: string
          format: objectid
      type: object
  securitySchemes:
    API-Key:
      type: apiKey
      name: x-API-Key
      in: header
    Bearer-Auth:
      type: http
      bearerFormat: JWT
      scheme: bearer

````