SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Tasks

Give work out, take it back with files, and record the decision.

Create a task, assign it to people or to a whole group, and each assignee gets their own copy with its own deadline, attempts and history. There is no public embed widget for this service - it runs server-side and in the dashboard.

Create a task

bash
curl -X POST https://app.softsolz.uk/api/v1/services/tasks/tasks \
-H "Authorization: Bearer sk_live_your_key" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: task-9f2c1a" \
-d '{"title":"Monthly safety write-up","submission_mode":"file_and_text","required_files":1,"status":"published"}'

Give it to a group

bash
curl -X POST https://app.softsolz.uk/api/v1/services/tasks/tasks/412/assign \
-H "Authorization: Bearer sk_live_your_key" \
-H "Content-Type: application/json" \
-d '{"group_ids":[3],"user_ids":[31]}'

Anyone already assigned is skipped rather than assigned twice, so re-running the same call is safe.

See what is waiting for review

bash
curl -G https://app.softsolz.uk/api/v1/services/tasks/assignments \
-H "Authorization: Bearer sk_live_your_key" \
-d awaiting_review=true

Decide on a submission

bash
curl -X POST https://app.softsolz.uk/api/v1/services/tasks/submissions/8317/review \
-H "Authorization: Bearer sk_live_your_key" \
-H "Content-Type: application/json" \
-d '{"decision":"approved","feedback":"Clear and complete.","score":92}'

Approving completes the assignment; changes_requested sends it back for another attempt and keeps the earlier one. Only the raw score is stored - letters and pass/fail labels come from the category’s grading scheme.

Statuses and the board

GET /status-sets lists the workspace and per-category statuses, and PUT /status-sets saves one set (category_id: null for the workspace). Each status has a category (to_do, in_progress, in_review, changes, done, blocked, cancelled) plus optional allowed_next, wip_limit and move rules. Move a piece of work with POST /assignments/:id/move; moving into another category runs the same step as the dashboard, and a refusal carries a code such as move_not_allowed, wip_limit_reached or comment_required. GET /board returns the statuses and up to 500 cards.

bash
curl -X POST https://app.softsolz.uk/api/v1/services/tasks/assignments/900/move \
-H "Authorization: Bearer sk_live_your_key" \
-H "Content-Type: application/json" \
-d '{"to_state":"done","comment":"Looks good."}'

Your own fields

GET /field-defs?scope=task|assignment&category_id= returns the fields that apply, and PUT /field-defs replaces the fields for one scope (at most 50). Task values are sent as custom_fields on create and update; the person doing the work sets theirs with PATCH /assignments/:id/fields. Bad values answer 422 fields_invalid with each field named in details.errors.

Repeating tasks

PUT /tasks/:id/schedule turns a task that has not been given out yet into a repeating pattern, and POST /schedule/preview returns the dates a schedule would produce without saving it.

bash
curl -X PUT https://app.softsolz.uk/api/v1/services/tasks/tasks/412/schedule \
-H "Authorization: Bearer sk_live_your_key" \
-H "Content-Type: application/json" \
-d '{"freq":"weekly","by_day":["mo"],"starts_on":"2026-12-07","due_time":"17:00","assignee_user_ids":[31,44],"rotation":"round_robin"}'

Dependencies, escalation and approval stages

  • POST /tasks/:id/dependencies with depends_on_task_id and dependency_type (finish_to_start, start_to_start, finish_to_finish); loops answer 409 dependency_cycle. GET|PUT /dependency-rules reads and sets what a link holds back.
  • PUT /categories/:id/escalation sets up to 5 steps, each with after_hours, relative (overdue or before_due) and its actions.
  • PUT /categories/:id/approval-policy sets up to 5 approval stages (mode any, all, min or majority); GET /assignments/:id/stages shows where a piece of work stands and POST /assignments/:id/withdraw-approval takes back your own approval while its stage is open.

Discussion with files

POST /tasks/:id/comments takes body, an optional assignment_id for the private thread, parent_comment_id for a reply, mentions (member ids, notified only when they can see the thread) and up to 10 file_ids from the file upload endpoints.

bash
curl -X POST https://app.softsolz.uk/api/v1/services/tasks/tasks/412/comments \
-H "Authorization: Bearer sk_live_your_key" \
-H "Content-Type: application/json" \
-d '{"body":"Please redo section 4.","assignment_id":900,"mentions":[31],"file_ids":["f0000000-0000-0000-0000-000000000001"]}'

Who a call acts as

Writes act as a member

A plain API key writes as the member who created the key, and a connected AI app writes as the member who connected it. Set-up and planning calls (types, numbering, shifts, projects, goals) also need that member to hold the matching permission, and an action they could not take in the dashboard answers 403. Starting a timer, logging time, or accepting and declining work is recorded for that member.

Reads differ. A connected AI app sees only what its member could see in the dashboard, so hidden work answers 404. A plain API key reads across the workspace, limited by the scopes on the key.

Types, tags, subtasks and numbers

  • GET|POST /types and PATCH|DELETE /types/:id manage task types. A type carries its own fields, statuses, checklist, defaults and number prefix, and PUT /types/:id/approval-policy gives it approval stages that win over the category's. Send type_id on POST /tasks; a type's settings win over the category's, which win over the workspace's.
  • GET|POST /tags, PATCH|DELETE /tags/:id and PUT /tasks/:id/tags (up to 20, by tag_ids or names; new names are created).
  • GET /tasks/:id/subtasks, POST /tasks/:id/subtasks (up to 3 levels) and POST /tasks/:id/parent to move a task under another one. PUT /tasks/:id/completion-rule decides when the parent counts as done: manual, all, selected (with task_ids) or percent.
  • POST /tasks and PATCH /tasks/:id also take tags, org_unit_id, project_id, milestone_id, assignment_mode, requires_acceptance, instructions_html, the planning fields (impact, urgency, risk, estimate_minutes, budget_cents, actual_cost_cents, cost_currency) and external_ref. PUT /tasks/:id/watchers takes roles to make someone a helper, consulted or informed instead of a plain watcher.
  • GET|PUT /settings/numbering switches task numbers on (enabled, prefix, pad), and GET /tasks/by-number/:ref finds a task by its number, for example HK-0042. Existing tasks keep the number they had, or none.
bash
curl -X POST https://app.softsolz.uk/api/v1/services/tasks/tasks/412/subtasks \
-H "Authorization: Bearer sk_live_your_key" \
-H "Content-Type: application/json" \
-d '{"title":"Check the fire exits","due_at":"2026-12-04T17:00:00Z","tags":["safety"]}'

Assignment modes, accept and decline

PUT /tasks/:id/assignment-mode chooses how work is shared out before anyone has it: independent (everyone does their own, as before), shared (the first required_count people to finish close it for all), sequential (one person at a time, in order) or primary_helpers. GET /tasks/:id/queue shows who is waiting their turn and POST /tasks/:id/queue/skip skips someone. Once people have the work the mode answers 409 mode_locked.

When a task needs accepting, the person given the work answers with POST /assignments/:id/accept or POST /assignments/:id/decline (a reason of 3 to 500 characters). Only that person can answer, so use their connection or a key they created; anyone else gets 403 not_assignee. Work that came from a group or unit is offered to someone else after a decline.

bash
curl -X POST https://app.softsolz.uk/api/v1/services/tasks/assignments/900/decline \
-H "Authorization: Bearer sk_live_their_key" \
-H "Content-Type: application/json" \
-d '{"reason":"I am away that week."}'

Departments and locations

GET /org-unitslists the workspace's units (departments, locations, sites, teams) and their kinds. It is read only: units are set up in the dashboard. Use a unit id as org_unit_id on a task, shift, project or goal, and as a filter on the calendar and timeline.

Shifts and handovers

  • GET /shifts?from=&to= (up to 62 days), POST /shifts, PATCH|DELETE /shifts/:id and POST /shifts/:id/copy plan shifts.
  • POST /shifts/:id/open starts one; POST /shifts/:id/close hands its open work over, with one action per item: carry to the next shift, reassign to someone on it, or leave.
  • GET /handovers, GET /handovers/:id and POST /handovers/:id/acknowledge for the incoming shift.
bash
curl -X POST https://app.softsolz.uk/api/v1/services/tasks/shifts/77/close \
-H "Authorization: Bearer sk_live_your_key" \
-H "Content-Type: application/json" \
-d '{"to_shift_id":78,"notes":"Boiler still noisy.","items":[{"assignment_id":900,"action":"carry"},{"assignment_id":901,"action":"reassign","to_user_id":44}]}'

Inspections

A task type can carry a form, so the person doing the work fills it in (and signs it when the type asks for a signature). GET /inspections lists results (outcome=fail for failed ones, plus type_id, task_id, assignee, from and to), and GET /inspections/:id returns the answers with any corrective actions and reinspections it created.

Time, timers and time approval

  • GET /time/running, POST /time/start (a running timer is stopped first) and POST /time/stop.
  • GET|POST /time/entries and PATCH|DELETE /time/entries/:id log time by hand, from 1 minute to 24 hours, with an end time or minutes and an optional billable flag.
  • When the workspace approves time, POST /time/submit sends finished entries, GET /time/approvals lists what waits for you, and POST /time/entries/:id/decide approves or rejects. Nobody decides on their own time (403 own_entry), and approved time cannot be changed or deleted.
bash
curl -X POST https://app.softsolz.uk/api/v1/services/tasks/time/entries \
-H "Authorization: Bearer sk_live_your_key" \
-H "Content-Type: application/json" \
-d '{"task_id":412,"started_at":"2026-12-01T09:00:00Z","minutes":90,"note":"Site visit","billable":true}'

Projects, milestones, goals and key results

  • GET|POST /projects, GET|PATCH|DELETE /projects/:id (deleting keeps its tasks).
  • GET|POST /projects/:id/milestones, PATCH|DELETE /milestones/:id and POST /milestones/:id/complete.
  • GET|POST /goals, GET|PATCH|DELETE /goals/:id, POST /goals/:id/key-results, PATCH|DELETE /key-results/:id, and POST /key-results/:id/check-in with a new value (history at GET /key-results/:id/check-ins).
bash
curl -X POST https://app.softsolz.uk/api/v1/services/tasks/key-results/12/check-in \
-H "Authorization: Bearer sk_live_your_key" \
-H "Content-Type: application/json" \
-d '{"value":64,"note":"Two more sites signed off."}'

Calendar, timeline and resource bookings

  • GET /calendar?from=&to= (up to 62 days) returns work by due date, and GET /timeline returns tasks with start and due dates and the links between them. Both filter by assignee, mine, type_id, tag_ids, org_unit_id (with include_sub_units) and project_id.
  • GET /resources lists the equipment, vehicles and rooms that can be booked, and GET /resources/:id/schedule shows when one is busy.
  • GET|POST /tasks/:id/bookings and DELETE /tasks/:id/bookings/:bookingId. A clash answers 409 resource_busy with the times that clash.
bash
curl -X POST https://app.softsolz.uk/api/v1/services/tasks/tasks/412/bookings \
-H "Authorization: Bearer sk_live_your_key" \
-H "Content-Type: application/json" \
-d '{"resource_id":5,"starts_at":"2026-12-03T08:00:00Z","ends_at":"2026-12-03T12:00:00Z","note":"Van for the site visit"}'

Exports

GET /tasks/:id/assignments.csv and GET /people/performance.csv take format=csv (the default), xlsx or pdf. Any other value answers 400 invalid_format. Spreadsheet cells that start with =, +, - or @ are written as plain text.

bash
curl -G https://app.softsolz.uk/api/v1/services/tasks/people/performance.csv \
-H "Authorization: Bearer sk_live_your_key" \
-d format=xlsx -o performance.xlsx

Webhooks

Tasks emits tasks.assigned, tasks.submitted, tasks.changes_requested, tasks.completed, tasks.reopened, tasks.overdue, tasks.status_changed, tasks.field_changed, tasks.escalated, tasks.unblocked, tasks.accepted, tasks.declined, tasks.subtasks_completed, tasks.shift_closed, tasks.handover_acknowledged, tasks.inspection_failed and tasks.milestone_completed, among others, so an HR or operations system can react the moment work moves.

Next

Browse every endpoint in the API Reference, or read the product walkthrough on docs.softsolz.uk.