← Sign in

API

Trigger a package from another system. One call creates the task and all its subtasks in ClickUp.

Authentication

Every call needs an API key. Someone with access to the app creates one under Settings → API keys. Send it in the Authorization header:

Authorization: Bearer ctc_your_key

The header X-API-Key: ctc_your_key works too.

Run a package

POST https://tasks.schooloftomorrow.ch/api/v1/packages/{package}/run

{package} is the package’s API name, for example onboarding-staff.

ParameterWhat it does
namerequiredName of the person. It becomes part of the task title.
messageoptionalFree text. It goes into the task description, below the other parameters.
anything elseoptionalEvery other parameter is accepted and written into the task description as Parameter: value, in the order you send it.

Send the parameters as a JSON object. Form fields and query parameters are accepted as well.

Example

curl -X POST https://tasks.schooloftomorrow.ch/api/v1/packages/onboarding-staff/run \
  -H "Authorization: Bearer ctc_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Doe",
    "Role": "Educator Kindergarten",
    "Campus": "Sihlberg",
    "Start date": "2027-01-04",
    "message": "Works Thursday mornings. Needs no laptop."
  }'

The task description in ClickUp then reads:

Role: Educator Kindergarten
Campus: Sihlberg
Start date: 2027-01-04

Works Thursday mornings. Needs no laptop.

Response

The call waits until everything is created (usually 5–15 seconds) and answers with 201:

{
  "run_id": 42,
  "status": "success",
  "package": "onboarding-staff",
  "name": "Jane Doe",
  "task_id": "86c1abcde",
  "task_url": "https://app.clickup.com/t/86c1abcde",
  "subtasks": 10,
  "error": null
}

List the packages

GET https://tasks.schooloftomorrow.ch/api/v1/packages
{
  "packages": [
    { "package": "onboarding-staff", "title": "Onboarding Staff",
      "optional_fields": ["Role", "Campus", "Start date"], "subtasks": 10 }
  ]
}

optional_fields are the fields the form in the app offers. The API does not require them and accepts any others.

Look up a run

GET https://tasks.schooloftomorrow.ch/api/v1/runs/{run_id}

Returns the same object as the run call.

Errors

Errors come back as { "error": "what went wrong" }.

StatusMeaning
400name is missing, or the body is not a JSON object.
401The API key is missing, wrong or revoked.
404There is no package with that API name.
502ClickUp refused or failed. The response includes run_id, and task_url if the main task was already created. Check it before retrying, so nothing is created twice.