# List timesheets

**GET /timesheets**


Manage your timesheets.

## Servers
- https://open.api.missionx.ai/v2: https://open.api.missionx.ai/v2 ()


## Authentication methods
- O auth2


## Parameters


#### Query parameters
- **type** (string)
  The timesheet type to filter timesheets by.
- **status** (array[string])
  One or more statuses to filter the timesheets by.
- **person** (array[string])
  Filter by one or more people. This is the org's `people[].person._id` value
- **project** (array[string])
  Filter project timesheets by one or more projects. This is the `project._id` value.
- **planItem** (array[string])
  Filter project timesheets by one or more plan items. This is the `planItem._id` value.
- **weekStart** (string)
  A date query to filter the results by the `weekStart` value. Format is `weekStart=<operator> <date>`, e.g. `weekStart=gt 2025-02-24T00:00:00.000Z`. Acceptable operations are `lt` = lower than, `lte` = lower than or equal, `gt` = greater than, `gte` = greater than or equal, `eq` = equal. The date is in [ISOString](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).
- **weekEnd** (string)
  A date query to filter the results by the `weekEnd` value. Format is `weekEnd=<operator> <date>`, e.g. `weekEnd=gt 2025-02-24T00:00:00.000Z`. Acceptable operations are `lt` = lower than, `lte` = lower than or equal, `gt` = greater than, `gte` = greater than or equal, `eq` = equal. The date is in [ISOString](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).
- **department** (array[string])
  Filter project timesheets by one or more project departments. This is the `org.departments[]._id` value that is assigned to the timesheet's plan item project `departments[]` array.
- **office** (array[string])
  Filter project timesheets by one or more project offices. This is the `org.offices[]._id` value that is assigned to the timesheet's plan item project `offices[]` array.
- **role** (array[string])
  Filter project timesheets by one or more plan item roles. This is the `org.roles[]._id` value that is assigned to the timesheet's plan item `role` field.
- **id** (array[string])
  One or more IDs to filter the response by. Compares against the document's `_id` value.
- **archived** (boolean | number)
  If true, only archived documents will be returned. Defaults to false. If you need both archived and non-archived, use `withArchived` instead.
- **withArchived** (boolean | number)
  If true, both archived and non-archived documents will be returned. Defaults to false.
- **updatedAt** (string)
  A date query to filter the results by the last `updatedAt` value. Format is `updatedAt=<operator> <date>`, e.g. `updatedAt=gt 2025-02-24T00:00:00.000Z`. Acceptable operations are `lt` = lower than, `lte` = lower than or equal, `gt` = greater than, `gte` = greater than or equal, `eq` = equal. The date is in [ISOString](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).
- **select** (array[string])
  One or more properties to be included in the response, instead of the full payload. E.g. `select=endDate,projectStatus`. You can also exclude fields by prefixing with a minus sign, e.g. `select=-endDate,-projectStatus`, but you cannot mix both.
- **sortBy** (string)
  Optionally, the field to sort the results by. By default, results are sorted by created date. Only `updatedAt` is supported at this moment (Note: `updatedAt` equals to `createdAt` for documents that have never been updated).
- **sortDirection** (string)
  Optionally, the direction to sort the documents by. For ascending (oldest first) use either `1` or `asc`. By default sorting is descending (latest first), `-1` or `desc`.
- **limit** (integer)
  Optionally, change the default document response limit of `40`.
- **count** (boolean | number)
  Includes a `count` property in the response, which holds the total number of results matching the query. The value does not change between pages and represents the accurate, total number of results to be expected.

Note: The use of this parameter will have a performance impact on the first paginated request.


## Responses
### 200: Successful response

#### Body Parameters: application/json (object)
- **value** (array[object])
  
- **nextLink** (string)
  The full URL to be used in order to fetch the next page of results. If not defined, it means there are no more pages.

Note: The documents are not being counted to know when all documents have been exhausted, we simply check if the length of the paginated list is less than the paginated limit. This means that if by coincidence the last paginated document list has the same length as the paginated limit, `nextLink` will be defined and will result in an empty list of documents.
- **count** (number)
  The total count of results for the specific request. It's included in the response only when the `count` boolean query parameter is provided and truthy, e.g. `?count=1`. The value is being calculated only during the first request and then repeated on the subsequent paginated responses.


[Powered by Bump.sh](https://bump.sh)