Search time entries

get deprecated

https://api.rocketlane.com/api/1.0/time-entries/search

This endpoint can be used to search for time entries. You can refine your search by adding filters. Filters are given as query parameters and have a defined structure: key is field.operator and value is value. For instance: date.gt=2023-02-11, minutes.eq=250. Apart from filters, you can add sortBy combined with sortOrder to sort the time entries. The response body is paginated and you can control the pagination using the limit and pageToken parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pageSize

number

≥ 0

This parameter sets the maximum number of responses to be displayed per page. If the page size is insufficient to accommodate the whole number of responses obtained, the pagination object will include a link to the next page as well as the next page token. If left blank, it defaults to 100.

pageToken

string

Use this parameter to specify the pageToken of a page to which you want to navigate. This pageToken can be obtained from a previous request which specified a limit and will only be active for 15 minutes after it is created.

includeFields

string

This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned.

includeAllFields

boolean

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

sortBy

string

enum

You can use the sortBy param to sort the responses by the given field. Valid fields to perform sortBy are: MINUTES, DATE, ID and BILLABLE.

Allowed:

sortOrder

string

enum

The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.

Allowed:

match

string

enum

You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.

Allowed:

date.gt

string

You can use this param to specify some date and the responses will contain time-entries whose date are greater than the given date.

date.eq

string

You can use this param to specify some date and the responses will contain exact matches of time-entries that match the given date.

date.lt

string

You can use this param to specify some date and the responses will contain time-entries whose date are less than the given date.

date.ge

string

You can use this param to specify some date and the responses will contain time-entries whose date are greater than or equal to the given date.

date.le

string

You can use this param to specify some date and the responses will contain time-entries whose date are less than or equal to the given date.

project.eq

number

You can use this param to specify some project Id and the responses will contain exact matches of time-entries that match the given project.

task.eq

number

You can use this param to specify some task Id and the responses will contain exact matches of time-entries that match the given task.

projectPhase.eq

number

You can use this param to specify some project phase Id and the responses will contain exact matches of time-entries that match the given phase.

category.eq

number

You can use this param to specify some category Id and the responses will contain exact matches of time-entries that match the given category.

user.eq

number

You can use this param to specify some user Id and the responses will contain exact matches of time-entries that belong to the user with the given user Id.

sourceType.eq

string

enum

You can use this param to specify a source type for the time entries and the responses will contain exact matches of time-entries that have the given source type.

Allowed:

activityName.eq

string

You can use this param to specify some activity name and the responses will contain exact matches of time-entries that match the given activity name.

activityName.cn

string

You can use this param to specify some text and the responses will contain time-entries that contain the given text in their activity name.

activityName.nc

string

You can use this param to specify some text and the responses will contain time-entries that DO NOT contain the given text in their activity name.

approvalStatus.eq

string

enum

You can use this param to specify an approval status for the time entries and the responses will contain exact matches of time-entries that have the given approval type.

Allowed:

Responses

200The requested action was successfully executed.

400This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.

401You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.