GET api/timesheet/summary?week={week}&user={user}&project={project}

Retrieves a summarized view of timesheet data for users, grouped by project and week.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
week

Optional week-ending date in the format defined by `Constants.TimesheetWeekFormat`.

string

None.

user

Optional user ID to filter timesheet summaries by user.

integer

Default value is 0

project

Optional project ID to filter timesheet summaries by project.

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

On success: HTTP 200 OK with a list of timesheet summaries grouped by user, project, and week. On failure: HTTP 400 Bad Request with a descriptive error message.

Collection of TimesheetSummary
NameDescriptionTypeAdditional information
user

User Details

ViewUserDTO

None.

summary

The week ending

Collection of TimesheetSummaryRow

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "user": {
      "userID": 1,
      "userName": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "email": "sample string 5",
      "customFields": [
        {
          "values": [
            "sample string 1",
            "sample string 2"
          ],
          "guid": "sample string 1",
          "type": "sample string 2",
          "dataType": "sample string 3"
        },
        {
          "values": [
            "sample string 1",
            "sample string 2"
          ],
          "guid": "sample string 1",
          "type": "sample string 2",
          "dataType": "sample string 3"
        }
      ],
      "status": "sample string 6",
      "createDate": "2025-11-21T03:18:53.3627466+00:00",
      "groups": [
        {
          "name": "sample string 1",
          "id": 2
        },
        {
          "name": "sample string 1",
          "id": 2
        }
      ]
    },
    "summary": [
      {
        "weekEnding": "2025-11-21T03:18:53.3627466+00:00",
        "id": 2,
        "project": "sample string 3",
        "hrs": 4.0
      },
      {
        "weekEnding": "2025-11-21T03:18:53.3627466+00:00",
        "id": 2,
        "project": "sample string 3",
        "hrs": 4.0
      }
    ]
  },
  {
    "user": {
      "userID": 1,
      "userName": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "email": "sample string 5",
      "customFields": [
        {
          "values": [
            "sample string 1",
            "sample string 2"
          ],
          "guid": "sample string 1",
          "type": "sample string 2",
          "dataType": "sample string 3"
        },
        {
          "values": [
            "sample string 1",
            "sample string 2"
          ],
          "guid": "sample string 1",
          "type": "sample string 2",
          "dataType": "sample string 3"
        }
      ],
      "status": "sample string 6",
      "createDate": "2025-11-21T03:18:53.3627466+00:00",
      "groups": [
        {
          "name": "sample string 1",
          "id": 2
        },
        {
          "name": "sample string 1",
          "id": 2
        }
      ]
    },
    "summary": [
      {
        "weekEnding": "2025-11-21T03:18:53.3627466+00:00",
        "id": 2,
        "project": "sample string 3",
        "hrs": 4.0
      },
      {
        "weekEnding": "2025-11-21T03:18:53.3627466+00:00",
        "id": 2,
        "project": "sample string 3",
        "hrs": 4.0
      }
    ]
  }
]

application/scim+json

Sample:
[
  {
    "user": {
      "userID": 1,
      "userName": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "email": "sample string 5",
      "customFields": [
        {
          "values": [
            "sample string 1",
            "sample string 2"
          ],
          "guid": "sample string 1",
          "label": null,
          "type": "sample string 2",
          "dataType": "sample string 3"
        },
        {
          "values": [
            "sample string 1",
            "sample string 2"
          ],
          "guid": "sample string 1",
          "label": null,
          "type": "sample string 2",
          "dataType": "sample string 3"
        }
      ],
      "status": "sample string 6",
      "createDate": "2025-11-21T03:18:53.3627466+00:00",
      "groups": [
        {
          "name": "sample string 1",
          "id": 2
        },
        {
          "name": "sample string 1",
          "id": 2
        }
      ]
    },
    "summary": [
      {
        "weekEnding": "2025-11-21T03:18:53.3627466+00:00",
        "id": 2,
        "project": "sample string 3",
        "hrs": 4.0
      },
      {
        "weekEnding": "2025-11-21T03:18:53.3627466+00:00",
        "id": 2,
        "project": "sample string 3",
        "hrs": 4.0
      }
    ]
  },
  {
    "user": {
      "userID": 1,
      "userName": "sample string 2",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "email": "sample string 5",
      "customFields": [
        {
          "values": [
            "sample string 1",
            "sample string 2"
          ],
          "guid": "sample string 1",
          "label": null,
          "type": "sample string 2",
          "dataType": "sample string 3"
        },
        {
          "values": [
            "sample string 1",
            "sample string 2"
          ],
          "guid": "sample string 1",
          "label": null,
          "type": "sample string 2",
          "dataType": "sample string 3"
        }
      ],
      "status": "sample string 6",
      "createDate": "2025-11-21T03:18:53.3627466+00:00",
      "groups": [
        {
          "name": "sample string 1",
          "id": 2
        },
        {
          "name": "sample string 1",
          "id": 2
        }
      ]
    },
    "summary": [
      {
        "weekEnding": "2025-11-21T03:18:53.3627466+00:00",
        "id": 2,
        "project": "sample string 3",
        "hrs": 4.0
      },
      {
        "weekEnding": "2025-11-21T03:18:53.3627466+00:00",
        "id": 2,
        "project": "sample string 3",
        "hrs": 4.0
      }
    ]
  }
]