Send forms and read answers with a hub key

This page covers sending forms and reading their answers with a hub key. Paths are under https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Calls

A form goes out in two steps: create it, then publish it. Until it's published, its recipients don't see it and nobody is told.

Creating a form

GET /forms/templates lists your published form templatesTemplate A reusable feed post, form, e-sign, note or task kept in the Library and copied onto cases., oldest first, with each one's asset_id, title, description, due_mins (how many minutes after it's sent it's due), rrule (its repeat), notifications and instant_notify.

POST /forms takes:

A template brings its document, description, reminders and instant_notify, but not its due time or repeat: work out due_date from due_mins, and send its rrule if it has one.

curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/forms \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Case intake form", "duration": {"due_date": "2026-10-09T17:00:00-04:00"}, "participants_ids": ["cu-4f1c2a9e8b7d60"], "template": {"owner": "host", "template_id": "form::20260915101500_3c2b1a0f9e8d70"}}'

It answers 201 with the form_id. The template's document is copied in the background: read the form until it has no copying, then publish it.

To send your own document instead, create the form without template, upload a PDF as its document, and wait until it's ready; see Upload and attach files with a hub key.

Publishing

PUT /forms/<form_id>/publish takes no body and answers 200.

• Each recipient is emailed a request to fill it in, or texted if they have no confirmed email, at once, unless instant_notify is false. It appears on their To DoTo Do The list on a case of things waiting for you, such as forms to fill in, documents to sign or events to confirm. and in their portal notifications.
• Reminders go out at each time in notifications still ahead. Nothing is sent at the due time, and answers are accepted after it.
• A repeating form moves to its next due date at each one, its answers clear, and everyone on it is asked again at once, unless instant_notify is false.
• Someone removed from the case is dropped from the form.

The document can't change once the form is published. Its name, due date, reminders, recipients and description can, with PUT /forms/<form_id>; a repeat sent without zoneinfo keeps the time zone it already has. Changing the due date, repeat or reminders sends the request again, at once, to everyone who hasn't answered, and people you add are sent it at once; with instant_notify false, neither goes until the reminders.

Reading answers

GET /forms/<form_id>/responses lists each person's answer, oldest first, all on one page. A repeating form lists only the current date's; an earlier date's answer is still read by its response_id.

{
  "data": {
    "items": [
      {
        "response_id": "response::20261003153012_9f8e7d6c5b4a30",
        "parent_id": "form::20261002150000_1a2b3c4d5e6f70",
        "user_id": "cu-4f1c2a9e8b7d60",
        "created_on": "2026-10-03T15:30:12+00:00",
        "response": {
          "format": "https://pspdfkit.com/instant-json/v1",
          "formFieldValues": [
            {"v": 1, "type": "pspdfkit/form-field-value", "name": "client_name", "value": "Jane Sample"},
            {"v": 1, "type": "pspdfkit/form-field-value", "name": "accident_date", "value": "2026-09-14"}
          ]
        }
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/forms/form::20261002150000_1a2b3c4d5e6f70/responses"
  }
}

• formFieldValues holds each field the person filled in, by the field's name. A signature or drawing comes under annotations and attachments.
• The form's own read shows who has answered: responses maps each person's user ID to their response_id.
• When someone submits, the staff on the case are told, as they would be if they'd sent the form themselves.

Deleting one person's answer, with {"user_id": "<their ID>"} as the body, puts the form back on their To Do. Nobody is told. A key can't fill in a form itself.

Listing forms

GET /forms needs filter:

Each form holds its form_id, name, participants_ids, due_date, published (1 once published), responses, responses_ct and its document under media.

DELETE /forms/<form_id> deletes a form at any time, with its answers, and takes it off everyone's To Do. Nobody is told.

If a call is refused

For the error body and the rest of the codes, see Handle API errors and status codes.