Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Time entry

Get time entries for a user on a workspace

get/v1/workspaces/{workspaceId}/user/{userId}/time-entries

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

userIdstring required

Represents a user identifier across the system.

Example:5a0ab5acb07987125438b60f

Represents a user identifier across the system.

Query parameters

descriptionstring

Represents a term for searching time entries by description.

Example:Description keywords

Represents a term for searching time entries by description.

startstring

Represents a start date in the yyyy-MM-ddThh:mm:ssZ format.

Example:2020-01-01T00:00:00Z

Represents a start date in the yyyy-MM-ddThh:mm:ssZ format.

endstring

Represents an end date in the yyyy-MM-ddThh:mm:ssZ format.

Example:2021-01-01T00:00:00Z

Represents an end date in the yyyy-MM-ddThh:mm:ssZ format.

projectstring

If provided, you'll get a filtered list of time entries that matches the provided string in their project id.

Example:5b641568b07987035750505e

If provided, you'll get a filtered list of time entries that matches the provided string in their project id.

taskstring

If provided, you'll get a filtered list of time entries that matches the provided string in their task id.

Example:64c777ddd3fcab07cfbb210c

If provided, you'll get a filtered list of time entries that matches the provided string in their task id.

tagsstring[]

If provided, you'll get a filtered list of time entries that matches the provided string(s) in their tag id(s).

If provided, you'll get a filtered list of time entries that matches the provided string(s) in their tag id(s).

[
  "5e4117fe8c625f38930d57b7",
  "7e4117fe8c625f38930d57b8"
]
project-requiredboolean

Flag to set whether to only get time entries which have a project.

Flag to set whether to only get time entries which have a project.

task-requiredboolean

Flag to set whether to only get time entries which have tasks.

Flag to set whether to only get time entries which have tasks.

hydratedboolean

Flag to set whether to include additional information on time entries or not.

Flag to set whether to include additional information on time entries or not.

pageinteger

Page number.

Example:1

Page number.

page-sizeinteger

Page size.

Example:50

Page size.

in-progressstring

Flag to set whether to filter only in progress time entries.

get-week-beforestring

Valid yyyy-MM-ddThh:mm:ssZ format date. If provided, filters results within the week before the datetime provided and only those entries with assigned project or task.

Example:2020-01-01T00:00:00Z

Valid yyyy-MM-ddThh:mm:ssZ format date. If provided, filters results within the week before the datetime provided and only those entries with assigned project or task.

Response

OK

billableboolean

Indicates whether a time entry is billable.

descriptionstring

Represents time entry description.

idstring

Represents time entry identifier across the system.

isLockedboolean

Represents whether time entry is locked for modification.

kioskIdstring

Represents kiosk identifier across the system.

projectIdstring

Represents project identifier across the system.

tagIdsstring[]

Represents a list of tag identifiers across the system.

taskIdstring

Represents task identifier across the system.

type'REGULAR' | 'BREAK' | 'HOLIDAY' | 'TIME_OFF'

Represents a time entry type enum.

userIdstring

Represents user identifier across the system.

workspaceIdstring

Represents workspace identifier across the system.

Example response

[
  {
    "costRate": {
      "amount": 10500,
      "currency": "USD"
    },
    "customFieldValues": [
      {
        "customFieldId": "5e4117fe8c625f38930d57b7",
        "name": "TIN",
        "timeEntryId": "64c777ddd3fcab07cfbb210c",
        "type": "WORKSPACE"
      }
    ],
    "description": "This is a sample time entry description.",
    "hourlyRate": {
      "amount": 10500,
      "currency": "USD"
    },
    "id": "64c777ddd3fcab07cfbb210c",
    "kioskId": "94c777ddd3fcab07cfbb210d",
    "projectId": "25b687e29ae1f428e7ebe123",
    "tagIds": [
      "321r77ddd3fcab07cfbb567y",
      "44x777ddd3fcab07cfbb88f"
    ],
    "taskId": "54m377ddd3fcab07cfbb432w",
    "timeInterval": {
      "duration": "8000",
      "end": "2021-01-01T00:00:00Z",
      "start": "2020-01-01T00:00:00Z"
    },
    "type": "BREAK",
    "userId": "5a0ab5acb07987125438b60f",
    "workspaceId": "64a687e29ae1f428e7ebe303"
  }
]