Form API

The Form API helps you get form results.
To use the Form API, you need an access token that you can get by authenticating with a user account, not a service account.
The API scopes are form and form.read.

Get form response results {#get-form-response}

You can get the response results of a form.

HTTP requestDescription
GET /forms/{formId}/responsesGet form response results
GET /forms/{formId}/responses/{responseId}/attachments/{attachmentId}Get a form response file

Note

  • For how to download a file, see Upload or Download Files.

Form response results {#form-answer-value}

The data type of a response returned when you get form response results is string, as shown in the following table.

questionTypeanswer
SINGLE_CHOICE , MULTIPLE_CHOICE , TEXT , DROPDOWNNo format. It is the value of each property.
RATINGNumber

Example) "1", "2.5"
SINGLE_DATE , MULTIPLE_DATE , DATE_INPUT , DATETIME_INPUTDate or date and time format.

Example)
- 2025.04.01 (Tue) → "2025-04-01"
(YYYY-MM-DD)
- 2025.04.01 (Tue) 09:30 → "2025-04-01T09:30:00+09:00"
(YYYY-MM-DDThh:mm:ssTZD)
- 2025.04.01 (Tue) 09:30 ~ 15:00 → "2025-04-01T09:30:00+09:00/2025-04-01T15:00:00+09:00"
(YYYY-MM-DDThh:mm:ssTZD/YYYY-MM-DDThh:mm:ssTZD)
- 2025.04.01 (Tue) AM → "2025-04-01T00:00:00+09:00/2025-04-01T11:59:59+09:00"
- 2025.04.01 (Tue) PM → "2025-04-01T12:00:00+09:00/2025-04-01T23:59:59+09:00"
ATTACHMENTattachmentId.

For how to get a file, see [Get a form response file].(/en/docs/form-response-attachment-get)

How to get a formId {#how-to-get-formid}

The Form API uses a formId to specify the form you want to get.

You can find the formId of a form in the LINE WORKS form URL of the desktop browser.

  1. Select a form you want to check the formId for on the form list page. For how to view the form summary page, see Form summary in LINE WORKS Help Center.
  2. Check the formId in the URL of the selected form summary page. The URL is in the https://form.worksmobile.com/forms/{formId}/summary format.

Note

  • Note that each recurring form has a different formId; select a form you want to check the formId for on the recurring form list and check the formId in the URL. For how to view the recurring form summary page, see Recurring form summary in LINE WORKS Help Center.