Skip to navigation
API v1 ReferenceTask Schedules

Returns a task schedule by id.

Returns a task schedule by id. The response includes the schedule’s task and timing settings.

Required Permissions
The user must have permission to access the requested resource.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

taskScheduleIdstringRequiredformat: "uuid"
The id of the task schedule.

Response

OK
idstringOptionalformat: "uuid"
The id of the entity.
createdOnstringOptionalformat: "date-time"
The date this entity was created.
createdBystringOptionalformat: "uuid"
The id of the user who created this entity.
updatedOnstringOptionalformat: "date-time"
The date this entity was last modified.
updatedBystringOptionalformat: "uuid"
The id of the user who last modified this entity.
userIdstringOptionalformat: "uuid"
The id of the user this task schedule is for.
taskIdstringOptionalformat: "uuid"
The id of the task this task schedule is for.
startDatestringOptionalformat: "date-time"
The start date and time of this task schedule.
endDatestringOptionalformat: "date-time"
The end date and time of this task schedule.
plannedDurationintegerOptional
The number of seconds of planned work.

Errors

401
Unauthorized Error
404
Not Found Error