SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Tasks

Read how a task repeats, with the next dates it will be made for

GEThttps://app.softsolz.uk/api/v1/services/tasks/tasks/{id}/schedule

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Response

Response Body

scheduleobject | nullHow the task repeats. Null when it does not repeat.
next_datesarray of stringsThe next few dates an occurrence will be made for.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/tasks/tasks/{id}/schedule \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"schedule": {
"id": 1,
"task_id": 1,
"freq": "weekly",
"interval_n": 2,
"by_day": [
"mo",
"th"
],
"by_month_day": 15,
"by_set_pos": 2,
"by_month": 1,
"business_days_only": true,
"skip_holidays": true,
"starts_on": "2026-01-01",
"ends_on": "2026-01-01",
"count_limit": 1,
"skip_dates": [
"2026-01-01"
],
"lead_days": 2,
"due_time": "17:00",
"timezone": "Europe/London",
"assignee_user_ids": [
1
],
"group_ids": [
1
],
"rotation": "none",
"is_active": true,
"occurrences_made": 1,
"next_run_on": "2026-01-01",
"last_generated_at": "2026-01-01T09:00:00.000Z"
},
"next_dates": [
"2026-01-01"
]
}
}