Skip to content

TimesheetEntries

Timesheet Entries represent time recorded within the Parallax Timesheets service, including additional properties related approval state.

Operations

List Timesheet Entries

Request

Gets a paginated list of timesheet entries recorded for a given time period with optional filtering by project offering, approval status, and etc. When no start or end date filters are provided, returns entries from the last 7 days (7 days ago through today).

Security
ApiKey
Query
pageinteger, (int32)

The specific page of results requested.

page_sizeinteger, (int32)

The number of results in each page.

start_datestring, (date)

Filter by entries recorded on or after this date. When not provided, defaults to 7 days ago from today. Currently, this endpoint requires the queried date range to not exceed 31 days. You must specify an end date filter when specifying this value. ISO date formatting expected (yyyy-MM-dd)

end_datestring, (date)

Filter by entries recorded on or before this date. When not provided, defaults to today. You must specify an start date filter when specifying this value. ISO date formatting expected (yyyy-MM-dd)

approval_statusstring(TimesheetSubmissionState)
Enum:"open""submitted""approved"
approval_status_start_datestring, (date)

Optional filter for entries with an approval status change on or after this date. Currently, this endpoint requires the queried date range to not exceed 31 days. You must specify an approval status end date filter when specifying this value. ISO date formatting expected (yyyy-MM-dd)

approval_status_end_datestring, (date)

Optional filter for entries with an approval status change on or before this date. You must specify an approval status start date filter when specifying this value. ISO date formatting expected (yyyy-MM-dd)

project_idstring, (uuid)

The id of the project in which the time entry belongs to.

project_offering_idstring, (uuid)

The id of the project offering in which the time entry belongs to.

curl -i -X GET \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/timesheet-entries?page=0&page_size=0&start_date=2019-08-24&end_date=2019-08-24&approval_status=open&approval_status_start_date=2019-08-24&approval_status_end_date=2019-08-24&project_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&project_offering_id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
countinteger, (int64)

The number of results in the current page.

totalinteger, (int64)

The total number of results that fulfill the request.

pageinteger, (int64)

The current page of results being returned.

total_pagesinteger, (int64)

The total number of available pages that fulfill the request.

page_sizeinteger, (int64)

The number of results in each page returned.

resultsArray of objects(TimesheetEntry)required

The array of result objects for the current page.

Response
{
  "count": 0,
  "total": 0,
  "page": 0,
  "total_pages": 0,
  "page_size": 0,
  "results": [
    { … }
  ]
}