SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceTasks

Gets the recurrency rule for the specified task.

GET
https://api.awork.com/api/v1/tasks/:taskId/recurrency
GET
/api/v1/tasks/:taskId/recurrency
1curl https://api.awork.com/api/v1/tasks/taskId/recurrency \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1{
2  "recurrencyRule": "\"0 0 1 * * ?\"",
3  "recurrencyInterval": 1,
4  "relativeDueOn": 3600,
5  "recurrencyStartOn": "2021-03-15T11:00:00Z",
6  "recurrencyTimezone": "Europe/Berlin"
7}
<Check> <b>Required Permissions</b>: `read` permissions on the task.</Check> <Info>Returns `404 NotFound` if no recurrence rule exists.</Info>
Was this page helpful?
Previous

Assigns a list of users to a given task

Next
Built with
Assigns a list of users to a given task

Authentication

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

Path parameters

taskIdstringRequiredformat: "uuid"

Response

OK
recurrencyRulestring or null
The recurrence rule as cron expression. We support all expressions which cronos supports (https://github.com/HangfireIO/Cronos). The number of occurrences is limited to 24 a day.
recurrencyIntervalinteger or null
The interval of the executed expression. If the value is 3, only the third time of the expression the recurrence is actually executed.
relativeDueOnlong or null
The relative due date and time of the task created from this recurrence rule, in seconds, from the moment of creating the task by a recurrence rule.
recurrencyStartOnstring or nullformat: "date-time"
DateTime when recurring task creation will start, considering the set Recurrency Rule and Recurrency Interval.
recurrencyTimezonestring or null
The timezone of the Recurrency Rule.
DateTime when recurring task creation will start, considering the set Recurrency Rule and Recurrency Interval.
The timezone of the Recurrency Rule.
OK

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

The recurrence rule as cron expression. We support all expressions which cronos supports (https://github.com/HangfireIO/Cronos). The number of occurrences is limited to 24 a day.

<Check> <b>Required Permissions</b>: read permissions on the task.</Check>

Returns 404 NotFound if no recurrence rule exists.