Timesheets

Timesheet related operations

Retrieves paginated timesheet entries (optional filter by employee email)

get

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Query parameters

emailstringOptional

Employee email; omit to return entries for all employees (paginated)

frominteger · int32Optional

Pagination start index (inclusive)

Default: 0Example: 0

tointeger · int32Optional

Pagination end index (exclusive). Page size is (to - from).

Default: 10Example: 10

dateFromstring · date-timeOptional

Start date filter (ddMMyyyy format)

dateTostring · date-timeOptional

End date filter (ddMMyyyy format)

Responses

200

OK

*/*

frominteger · int32Optional

tointeger · int32Optional

totalinteger · int32Optional

noContentbooleanOptional

get

/api/v1/public/company/timesheets

HTTPcURLJavaScriptPython

GET /api/v1/public/company/timesheets HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "from": 1,
  "to": 1,
  "total": 1,
  "noContent": true,
  "results": [
    {
      "email": "text",
      "externalId": "text",
      "timeZone": "text",
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "startTime": "2026-05-18T02:29:26.112Z",
      "endTime": "2026-05-18T02:29:26.112Z",
      "active": true,
      "breaks": [
        {
          "startTime": "2026-05-18T02:29:26.112Z",
          "endTime": "2026-05-18T02:29:26.112Z",
          "duration": 1
        }
      ],
      "periodType": "ACTIVE",
      "changeHistory": [
        {
          "startTime": "2026-05-18T02:29:26.112Z",
          "endTime": "2026-05-18T02:29:26.112Z",
          "breaks": [
            {
              "startTime": "2026-05-18T02:29:26.112Z",
              "endTime": "2026-05-18T02:29:26.112Z",
              "duration": 1
            }
          ],
          "periodType": "ACTIVE",
          "changeReason": "text",
          "changedBy": {
            "email": "text",
            "externalId": "text"
          },
          "changedAt": "2026-05-18T02:29:26.112Z"
        }
      ]
    }
  ]
}

Retrieves paginated deleted timesheet entries (optional filter by employee email)

get

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Query parameters

emailstringOptional

Employee email; omit to return entries for all employees (paginated)

frominteger · int32Optional

Pagination start index (inclusive)

Default: 0Example: 0

tointeger · int32Optional

Pagination end index (exclusive). Page size is (to - from).

Default: 10Example: 10

dateFromstring · date-timeOptional

Start date filter (ddMMyyyy format)

dateTostring · date-timeOptional

End date filter (ddMMyyyy format)

Responses

200

OK

*/*

frominteger · int32Optional

tointeger · int32Optional

totalinteger · int32Optional

noContentbooleanOptional

get

/api/v1/public/company/timesheets/deleted

HTTPcURLJavaScriptPython

GET /api/v1/public/company/timesheets/deleted HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "from": 1,
  "to": 1,
  "total": 1,
  "noContent": true,
  "results": [
    {
      "email": "text",
      "externalId": "text",
      "timeZone": "text",
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "originalTimesheetId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "startTime": "2026-05-18T02:29:26.112Z",
      "endTime": "2026-05-18T02:29:26.112Z",
      "breaks": [
        {
          "startTime": "2026-05-18T02:29:26.112Z",
          "endTime": "2026-05-18T02:29:26.112Z",
          "duration": 1
        }
      ],
      "periodType": "ACTIVE",
      "changeHistory": [
        {
          "startTime": "2026-05-18T02:29:26.112Z",
          "endTime": "2026-05-18T02:29:26.112Z",
          "breaks": [
            {
              "startTime": "2026-05-18T02:29:26.112Z",
              "endTime": "2026-05-18T02:29:26.112Z",
              "duration": 1
            }
          ],
          "periodType": "ACTIVE",
          "changeReason": "text",
          "changedBy": {
            "email": "text",
            "externalId": "text"
          },
          "changedAt": "2026-05-18T02:29:26.112Z"
        }
      ],
      "deletedAt": "2026-05-18T02:29:26.112Z",
      "deletedBy": "64f8a0e2d5b7c9a1e3f4a5b6",
      "deletedReason": "text"
    }
  ]
}