SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Tasks

Work out the dates a schedule would produce, without saving anything

POSThttps://app.softsolz.uk/api/v1/services/tasks/schedule/preview

Recent Requests

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

Headers

Authorizationstringrequired

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

Body Params

freqstringrequired

How often it repeats.

interval_ninteger

Repeat every N periods, 1 to 365. Defaults to 1.

by_dayarray of strings

Days of the week. Weekly: the days it happens on. Monthly or yearly with by_set_pos: the day to count.

by_month_dayinteger | null

Day of the month, 1 to 31, or -1 for the last day. A day the month does not have moves to its last day.

by_set_posinteger | null

With by_day: which one in the month, 1 to 5, or -1 for the last one.

by_monthinteger | null

Yearly only: the month, 1 to 12.

business_days_onlyboolean

Daily: count Monday to Friday only. Weekly: leave out Saturday and Sunday. Monthly and yearly: a weekend date moves to the next Monday.

skip_holidaysboolean

Leave out the days the business is closed (closed weekdays and holidays from the business calendar). Defaults to false.

starts_onstring

First possible date.

ends_onstring | null

Last possible date.

count_limitinteger | null

Stop after this many occurrences, 1 to 1000.

skip_datesarray of strings

Dates that never get an occurrence (up to 200).

lead_daysinteger

Create each occurrence this many days early, 0 to 60.

due_timestring | null

Deadline time on the day, HH:MM. Empty means the end of the day.

timezonestring

IANA time zone. Defaults to the workspace time zone.

assignee_user_idsarray of integers

People who get each occurrence.

group_idsarray of integers

Groups whose members get each occurrence.

rotationstring

round_robin gives each occurrence to the next person in turn.

is_activeboolean

Turn the repeat off without deleting it.

fromstring

Start listing from this date.

countinteger

How many dates, 1 to 50 (default 10).

Response

Response Body

datesarray of stringsThe dates, earliest first.

Request

curl --request POST \
--url https://app.softsolz.uk/api/v1/services/tasks/schedule/preview \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"freq": "weekly",
"interval_n": 2,
"by_day": [
"mo",
"th"
],
"by_month_day": 15,
"by_set_pos": 2,
"lead_days": 2,
"due_time": "17:00",
"timezone": "Europe/London"
}'

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": {
"dates": [
"2026-01-01"
]
}
}