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

# Get Running Timer

> Retrieve the authenticated user's currently running timer, or an empty timer payload if none is running.



## OpenAPI

````yaml /openapi.json get /timers/current
openapi: 3.1.1
info:
  title: Everhour API
  version: 1.0.0
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.everhour.com
security:
  - ApiKeyAuth: []
tags:
  - name: Clients
  - name: Custom Fields
  - name: Expenses
  - name: Invoices
  - name: Projects
  - name: Reports
  - name: Schedule
  - name: Tasks
  - name: Time Off
  - name: Time Records
  - name: Timecards
  - name: Timers
  - name: Timesheets
  - name: Users
  - name: Webhooks
paths:
  /timers/current:
    get:
      tags:
        - Timers
      summary: Get Running Timer
      description: >-
        Retrieve the authenticated user's currently running timer, or an empty
        timer payload if none is running.
      operationId: getRunningTimer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Timer'
        '401':
          description: Unauthorized
components:
  schemas:
    Timer:
      type: object
      properties:
        status:
          type: string
          enum:
            - active
            - stopped
          example: active
        duration:
          type: number
          description: Timer duration in seconds
          example: 16
        today:
          type: number
          description: Today time by user in the timer task
          example: 7200
        startedAt:
          type: string
          example: '2018-01-16 12:42:59'
        userDate:
          type: string
          example: '2018-01-16'
        comment:
          type: string
        task:
          $ref: '#/components/schemas/Task'
        user:
          $ref: '#/components/schemas/User'
        currentTaskTime:
          $ref: '#/components/schemas/TimeRecord'
        website:
          type: object
          nullable: true
          properties:
            url:
              type: string
            title:
              type: string
      required:
        - status
    Task:
      type: object
      properties:
        id:
          type: string
          example: ev:9876543210
        name:
          type: string
          example: Task Name
        type:
          type: string
          description: Object kind reported by the source platform.
          example: task
        url:
          type: string
          description: >-
            Link to the task in the source platform. Absent for native Everhour
            tasks.
          example: https://github.com/acme/web/issues/8688
        number:
          type: string
          description: >-
            Issue number or key in the source platform. Absent for native
            Everhour tasks.
          example: ED-774
        projects:
          type: array
          description: List of projects ID
          items:
            type: string
          example:
            - ev:1234567890
        section:
          type:
            - number
            - 'null'
          description: Section ID
          example: 1234
        labels:
          type: array
          items:
            type: string
          example:
            - high
            - bug
        position:
          type: number
          example: 1
        description:
          type:
            - string
            - 'null'
        dueAt:
          type:
            - string
            - 'null'
          description: 'Format: Y-m-d H:i:s'
          example: '2018-03-05 16:00:00'
        dueOn:
          type:
            - string
            - 'null'
          description: 'Due date without a time component. Format: Y-m-d'
          example: '2024-10-31'
        status:
          type: string
          enum:
            - open
            - completed
            - closed
          example: open
        completed:
          type: boolean
          description: >-
            Mirrors `status` — `true` when the task is done in the source
            platform.
          example: false
        completedAt:
          type:
            - string
            - 'null'
          description: 'When the task was completed. Format: Y-m-d H:i:s'
          example: '2024-01-24 14:36:20'
        createdAt:
          type: string
          description: 'Format: Y-m-d H:i:s'
          example: '2023-04-07 13:11:20'
        createdBy:
          type: number
          description: ID of the user who created the task. Native Everhour tasks only.
          example: 1304
        favorite:
          type: boolean
          description: Whether you marked this task as a favorite.
          example: false
        assignees:
          type:
            - array
            - 'null'
          description: >-
            Who the task is assigned to. `null` when the source platform reports
            no assignee data, and an empty array when the task is unassigned.
          items:
            $ref: '#/components/schemas/TaskAssignee'
        iteration:
          type: string
          description: >-
            Sprint, board column, or section the task sits in, as reported by
            the source platform.
          example: In Progress
        color:
          type: string
          description: Task color as a hex value. Native Everhour tasks only.
          example: '#edacc7'
        comments:
          type: number
          description: Number of comments on the task.
          example: 1
        time:
          $ref: '#/components/schemas/TaskTime'
        estimate:
          $ref: '#/components/schemas/TaskEstimate'
        attributes:
          type: object
          description: Custom attributes from integration
          additionalProperties:
            type: string
          example:
            Client: Everhour
            Priority: high
        metrics:
          type: object
          description: Custom metrics from integration
          additionalProperties:
            type: number
          example:
            efforts: 42
            expenses: 199
        unbillable:
          type: boolean
          description: '`true` when the task is marked as non-billable.'
          example: false
      required:
        - id
        - name
        - projects
    User:
      type: object
      description: >-
        A team member. `GET /team/users` and `GET /users/me` return the full
        object; `user` objects nested in other resources may contain a subset of
        these fields.
      properties:
        id:
          type: number
          example: 1304
        email:
          type: string
          example: john.bender@example.com
        name:
          type: string
          example: John Bender
        headline:
          type:
            - string
            - 'null'
          description: Job title. Empty string when not set.
          example: CEO
        phone:
          type: string
          description: Omitted when not set.
          example: +1 555 0100
        externalId:
          type: string
          description: >-
            Employee ID from your own system, set on the member profile. Omitted
            when not set.
          example: M-3490
        avatarUrl:
          type:
            - string
            - 'null'
          description: Omitted when the member has no avatar.
          example: https://d36887svjhykt4.cloudfront.net/users/1304-15ea197d07ca81.jpg
        avatarUrlLarge:
          type:
            - string
            - 'null'
          description: Omitted when the member has no avatar.
          example: https://d36887svjhykt4.cloudfront.net/users/1304-15ea197d10830c.jpg
        role:
          type: string
          enum:
            - admin
            - supervisor
            - member
            - member_limited
          example: admin
        status:
          type: string
          enum:
            - active
            - invited
            - pending
            - removed
          example: active
        type:
          type: string
          enum:
            - employee
            - contractor
          example: employee
        createdAt:
          type: string
          description: 'Format: Y-m-d H:i:s'
          example: '2016-08-13 15:27:30'
        isEmailVerified:
          type: boolean
          example: true
        capacity:
          type:
            - integer
            - 'null'
          description: Weekly capacity in seconds.
          example: 144000
        cost:
          type: integer
          description: >-
            Hourly cost in cents. Returns `0` when you lack the `costs`
            permission.
          example: 2500
        costHistory:
          type:
            - array
            - 'null'
          description: >-
            Past hourly cost values. `null` when the member has no cost history
            or you lack the `costs` permission.
          example: null
        groups:
          type: array
          description: >-
            Groups the member belongs to. Empty array when the member is in no
            group.
          items:
            $ref: '#/components/schemas/UserGroup'
        permissions:
          $ref: '#/components/schemas/UserPermissions'
        timeTrackingPolicy:
          $ref: '#/components/schemas/TimeTrackingPolicy'
        resourcePlannerAccess:
          $ref: '#/components/schemas/ResourcePlannerAccess'
        favorite:
          type: boolean
          description: Whether you marked this member as a favorite.
          example: false
      required:
        - id
        - email
        - name
        - role
        - status
        - type
        - createdAt
        - isEmailVerified
        - groups
        - permissions
        - timeTrackingPolicy
        - favorite
    TimeRecord:
      type: object
      properties:
        id:
          type: number
          description: Time record ID
          example: 2660155
        time:
          type: number
          description: Time recorded in seconds
          example: 3600
        user:
          type: number
          description: User ID
          example: 1304
        date:
          type: string
          description: Date
          example: '2018-01-20'
        task:
          $ref: '#/components/schemas/Task'
        isLocked:
          type: boolean
          example: false
        isInvoiced:
          type: boolean
          example: false
        comment:
          type: string
          example: some notes
      required:
        - id
        - time
        - user
        - date
    TaskAssignee:
      type: object
      description: >-
        A task assignee. Integration tasks report the account from the source
        platform; native Everhour tasks return `userId` only.
      properties:
        userId:
          type: number
          description: >-
            Everhour user ID. Present when the platform account is linked to a
            team member.
          example: 1304
        accountId:
          type: string
          description: Account ID in the source platform.
          example: gh:313991
        accountName:
          type: string
          description: Account name in the source platform.
          example: jbender
    TaskTime:
      type: object
      properties:
        total:
          type: number
          description: Total task time in seconds
          example: 7200
        users:
          type: object
          description: Task time per user ID
          additionalProperties:
            type: number
          example:
            '1304': 3600
            '1543': 3600
        timerTime:
          type: number
          description: >-
            Part of `total` that came from timers rather than manual entry, in
            seconds.
          example: 5400
      required:
        - total
        - users
    TaskEstimate:
      type: object
      properties:
        total:
          type: number
          description: Total task estimate in seconds
          example: 7200
        type:
          type: string
          enum:
            - overall
            - users
          example: overall
        users:
          type: object
          description: Task estimate per user ID
          additionalProperties:
            type: number
          example:
            '1304': 3600
            '1543': 3600
      required:
        - total
        - type
    UserGroup:
      type: object
      description: A group the user belongs to.
      properties:
        id:
          type: number
          example: 1
        name:
          type: string
          example: Admins
      required:
        - id
        - name
    UserPermissions:
      type: object
      description: >-
        Areas the user can access beyond the base role. A key is present only
        when the user has access to that area. Users with no elevated access
        return an empty array (`[]`) instead of an object — treat both as "no
        permissions".
      properties:
        billingBudgets:
          type: string
          enum:
            - read
            - write
          example: write
        userLimits:
          type: string
          enum:
            - read
            - write
          example: write
        costs:
          type: string
          enum:
            - read
            - write
          example: write
        invoices:
          type: string
          enum:
            - read
            - write
          example: write
        expenses:
          type: string
          enum:
            - read
            - write
          example: write
    TimeTrackingPolicy:
      type: object
      description: >-
        Time tracking rules that apply to the user. Team defaults unless the
        team overrides them for this member.
      properties:
        allowTimeWithoutTask:
          type: boolean
          example: true
        allowManualTimeInput:
          type: boolean
          example: true
        allowFutureTime:
          type: boolean
          example: false
        allowCompletedTaskTime:
          type: boolean
          example: true
        allowTimeWithoutEstimate:
          type: boolean
          example: true
        allowExceedEstimate:
          type: boolean
          example: false
        allowManageEstimates:
          type: boolean
          example: true
        lockTimeAfter:
          type: integer
          description: >-
            Number of `lockTimePeriod` units after which time entries lock.
            Present only when the team locks time for this member.
          example: 2
        lockTimePeriod:
          type: string
          description: >-
            Unit used by `lockTimeAfter`. Present only when the team locks time
            for this member.
          example: days
    ResourcePlannerAccess:
      type: object
      description: Resource planner access flags. Returned for the authenticated user.
      properties:
        viewMine:
          type: boolean
          example: false
        editMine:
          type: boolean
          example: false
        viewAll:
          type: boolean
          example: false
        editAll:
          type: boolean
          example: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

````

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