Information Fields

Information fields belonging to a Project, Session or Participant can be read, created and modified. They cannot be created or modified independently; instead, they must be supplied when creating or updating one of the above resources.

An information field in the API is represented as a JSON object with the following properties:

{
  "fieldName": "string",
  "fieldType": "text",
  "value": "string"
}

The API uses fieldName to match information fields, so field names are guaranteed to be unique within each resource. When creating or modifying a resource with Information Fields, if the supplied fieldName already exists in that resource, its corresponding value will be modified with the supplied value. If the fieldName does not exist in the resource, a new information field will be created, provided a valid fieldType is supplied.

fieldType represents the type of the information field. Existing UI field types are mapped to API types as follows:

The following example demonstrates updating an existing Project with information fields.

The Project shown above has 4 Information Fields:

• Start Date of fieldType date

• Status of fieldType single_select

• End Date of fieldType date

• Internal of fieldType boolean

A GET request to fetch this Project using its id would return the following response.

{
  "id": "t7mY2pQsX9Lw3ZhdVj0K",
  "name": "User Feedback",
  "updatedAt": "2025-10-08T14:09:37.427Z",
  "projectFolderId": "s2nqK0wYh5tOeBkaiHxW",
  "workspaceId": "willoughby",
  "informationFields": [
    {
      "fieldName": "Status",
      "fieldType": "single_select",
      "value": "Preparation"
    },
    {
      "fieldName": "Start Date",
      "fieldType": "date",
      "value": "2025-10-08"
    }
  ],
  "involvedContributorIds": [
    "k7zvUoX3qJmW9aP2eRtgS8LbYnHd"
  ]
}

Here’s a sample request body to update this Project :

{
  "informationFields": [
    {
      "fieldName": "Internal",
      "value": true
    },
    {
      "fieldName": "Research Method",
      "fieldType": "single_select",
      "value": "Usability Test"
    }
  ]
}

With this update, the existing information field “Internal” will be set to true (checked in the UI) and a new single_select field called Research Method will be created with the value Usability Test. Here’s the corresponding response for the update request:

{
  "id": "t7mY2pQsX9Lw3ZhdVj0K",
  "name": "User Feedback",
  "updatedAt": "2025-10-08T14:17:26.461Z",
  "projectFolderId": "s2nqK0wYh5tOeBkaiHxW",
  "workspaceId": "willoughby",
  "informationFields": [
    {
      "fieldName": "Research Method",
      "fieldType": "single_select",
      "value": "Usability Test"
    },
    {
      "fieldName": "Status",
      "fieldType": "single_select",
      "value": "Preparation"
    },
    {
      "fieldName": "Start Date",
      "fieldType": "date",
      "value": "2025-10-08"
    },
    {
      "fieldName": "Internal",
      "fieldType": "checkbox",
      "value": true
    }
  ],
  "involvedContributorIds": [
    "k7zvUoX3qJmW9aP2eRtgS8LbYnHd"
  ]
}