Questionnaires

Manage the intake questionnaires patients fill out for your organisation: list and inspect existing questionnaires, create new ones, update their metadata, and update the SurveyJS model/theme that renders the questionnaire itself.

This endpoint set covers questionnaire metadata and the SurveyJS model only. Authoring features like files, CSS snippets, archiving, duplication, and product-recommendation mappings are managed in the Admin Tool, not through this API.

List Questionnaires

GET /v1/management/questionnaires

integer

default:"0"

Page number (0-indexed). Ignored when all=true.

integer

default:"25"

Number of questionnaires per page. Ignored when all=true.

string

default:""

Filter by identifier substring (case-insensitive)

boolean

default:"false"

Return archived (true) or non-archived (false) questionnaires

boolean

default:"false"

Return the complete result set without pagination

Required permission: questionnaire:read

Example Request

curl -X GET "https://api.rxscale.com/v1/management/questionnaires?page=0&limit=25&search=intake" \
  -H "X-API-Key: your-api-key-here"

Response

List items omit model, mapping, theme, meta_data, and url — use Get a Questionnaire to read those.

{
  "data": [
    {
      "uid": "quest-abc123",
      "identifier": "weight-loss-intake",
      "version": "1",
      "type": "PRODUCT_RECOMMENDER",
      "archived": false,
      "store_anamnesis_at_patient_level": false,
      "organisation_uid": "org-xyz789",
      "created_at": 1717430400,
      "updated_at": 1717430400,
      "deleted_at": null
    }
  ],
  "totalRegistries": 1,
  "totalPages": 1
}

Response Fields

Field	Type	Description
`data`	array	Questionnaires for the organisation
`data[].uid`	string	Questionnaire UID
`data[].identifier`	string	Questionnaire identifier
`data[].type`	string	Questionnaire type (e.g. `PRODUCT_RECOMMENDER`, `DIRECT_TO_CART`)
`data[].version`	string	Questionnaire schema version
`data[].archived`	boolean	Whether the questionnaire is archived
`data[].store_anamnesis_at_patient_level`	boolean	Whether submissions are also stored on the patient profile
`data[].organisation_uid`	string	Owning organisation UID
`totalRegistries`	integer	Total matching questionnaires
`totalPages`	integer	Total number of pages (`1` when `all=true`)

Get a Questionnaire

GET /v1/management/questionnaires/{questionnaire_uid}

string

required

The questionnaire UID

Required permission: questionnaire:read

Example Request

curl -X GET "https://api.rxscale.com/v1/management/questionnaires/quest-abc123" \
  -H "X-API-Key: your-api-key-here"

Response

Includes the SurveyJS model/theme plus every relationship the record carries. These are raw linkage arrays from the underlying data model rather than a curated public shape, so expect UIDs (not nested objects) and — for a questionnaire with real usage — potentially long arrays; they are typically empty only for a questionnaire created and managed solely through this API:

{
  "uid": "quest-abc123",
  "identifier": "weight-loss-intake",
  "version": "1",
  "type": "PRODUCT_RECOMMENDER",
  "url": null,
  "model": {
    "title": "Weight Loss Intake",
    "pages": [
      {
        "name": "BasicInfo",
        "elements": [
          {"type": "text", "name": "age", "title": "Age"}
        ]
      }
    ]
  },
  "mapping": null,
  "theme": null,
  "meta_data": {"save_number": 1},
  "archived": false,
  "store_anamnesis_at_patient_level": false,
  "organisation_uid": "org-xyz789",
  "categories": [],
  "products": [],
  "recommendations": [],
  "doctors": [],
  "patient_profile_fields": [],
  "anamnesis_list": [],
  "created_at": 1717430400,
  "updated_at": 1717430500,
  "deleted_at": null
}

Response Fields

Field	Type	Description
`uid`	string	Questionnaire UID
`identifier`	string	Questionnaire identifier
`version`	string	Questionnaire schema version
`type`	string	Questionnaire type
`model`	object \| null	SurveyJS model (pages, elements)
`mapping`	array \| null	Internal answer-to-attribute mapping
`theme`	object \| null	SurveyJS theme
`meta_data`	object \| null	Internal metadata, including `save_number` (see Update Questionnaire Model)
`archived`	boolean	Whether the questionnaire is archived
`store_anamnesis_at_patient_level`	boolean	Whether submissions are also stored on the patient profile
`organisation_uid`	string	Owning organisation UID
`categories`	array of strings	UIDs of the questionnaire’s category-assignment rows (Admin Tool authoring feature)
`products`	array of strings	UIDs of the questionnaire-to-product link rows (not the linked products’ own UIDs)
`recommendations`	array of strings	UIDs of the questionnaire’s product-recommendation rows
`doctors`	array of strings	UIDs of the doctors this questionnaire is assigned to
`patient_profile_fields`	array of objects	`{"model_key": ..., "questionnaire_uid": ...}` for each patient-profile-field mapping (this join table has a composite key, not its own UID)
`anamnesis_list`	array of strings	UIDs of every submission ever made for this questionnaire — unbounded, so it can be large for a heavily-used questionnaire; use Questionnaire Submission Statistics for counts instead of this array

The Admin Tool’s questionnaire authoring features (custom CSS, file assets, archiving, duplication) are not exposed by this API; the arrays above only reflect the linkages, not those authoring actions.

Error Responses

Status Code	Description
`401`	Missing or invalid credentials
`403`	Valid credentials, but missing `questionnaire:read`
`404`	Questionnaire not found or belongs to another organisation

Create a Questionnaire

POST /v1/management/questionnaires

Required permission: questionnaire:write

string

required

Questionnaire identifier

string

required

Questionnaire type (e.g. PRODUCT_RECOMMENDER, DIRECT_TO_CART)

Example Request

curl -X POST "https://api.rxscale.com/v1/management/questionnaires" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"identifier": "weight-loss-intake", "type": "PRODUCT_RECOMMENDER"}'

Response

Returns 201 with the created questionnaire, in the same shape as Get a Questionnaire. model, mapping, theme, and meta_data are null until set via Update Questionnaire Model.

Error Responses

Status Code	Description
`400`	Missing `identifier` or `type`
`401`	Missing or invalid credentials
`403`	Valid credentials, but missing `questionnaire:write`

Update Questionnaire Metadata

PATCH /v1/management/questionnaires/{questionnaire_uid}

Updates questionnaire metadata. All body fields are optional; send only the ones you want to change. The SurveyJS model and theme are not accepted here. Publish those with Update Questionnaire Model. Required permission: questionnaire:write

string

required

The questionnaire UID

string

New identifier

string

New questionnaire type

boolean

Whether submissions are also stored on the patient profile

array

Internal answer-to-attribute mapping (array of objects, or null).

Example Request

curl -X PATCH "https://api.rxscale.com/v1/management/questionnaires/quest-abc123" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"identifier": "weight-loss-intake-v2"}'

Response

Returns 200 with the updated questionnaire, in the same shape as Get a Questionnaire.

Error Responses

Status Code	Description
`400`	Invalid payload
`401`	Missing or invalid credentials
`403`	Valid credentials, but missing `questionnaire:write`
`404`	Questionnaire not found or belongs to another organisation

Update Questionnaire Model

PATCH /v1/management/questionnaires/{questionnaire_uid}/model

Replaces the live SurveyJS model of a questionnaire owned by your organisation. The change is published immediately and any older autosaved draft is removed.

This endpoint changes the questionnaire shown to patients immediately. Send the complete SurveyJS model, not a partial patch.

Required permission: questionnaire:write

string

required

The questionnaire UID

object

required

The complete SurveyJS questionnaire model to publish.

object

Complete SurveyJS theme. Omit it to keep the current theme.

Example Request

curl -X PATCH "https://api.rxscale.com/v1/management/questionnaires/quest-abc123/model" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "model": {
      "title": "Weight Loss Intake",
      "pages": [
        {"name": "BasicInfo", "elements": [{"type": "text", "name": "age", "title": "Age"}]}
      ]
    }
  }'

Response

Returns 200 with uid, model, and theme only.

Error Responses

Status Code	Description
`400`	Missing `model`, or invalid payload
`401`	Missing or invalid credentials
`403`	Valid credentials, but missing `questionnaire:write`
`404`	Questionnaire not found or belongs to another organisation

Questionnaire Submission Statistics

GET /v1/management/questionnaires/{questionnaire_uid}/statistics/submissions

Returns the number of submissions per day for a questionnaire.

For organisation-wide statistics (order/prescription volume, doctor and product counts, submissions across all questionnaires), see Statistics.

Required permission: statistics:read

string

required

The questionnaire UID

string

Start of the date range (ISO 8601). Defaults to 30 days before end_date.

string

End of the date range (ISO 8601). Defaults to now.

Defaults to the last 31 days (today and the previous 30 days) when no date range is given. The range between start_date and end_date may not exceed 30 days.

Example Request

curl -X GET "https://api.rxscale.com/v1/management/questionnaires/quest-abc123/statistics/submissions?start_date=2026-08-01T00:00:00&end_date=2026-08-31T23:59:59" \
  -H "X-API-Key: your-api-key-here"

Response

Every day in the range is included, with 0 for days with no submissions:

[
  {"date": "2026-08-01", "count": 3},
  {"date": "2026-08-02", "count": 0},
  {"date": "2026-08-03", "count": 5}
]

Response Fields

Field	Type	Description
`date`	string	Calendar date (`YYYY-MM-DD`)
`count`	integer	Number of submissions on that date

Error Responses

Status Code	Description
`400`	The date range exceeds 30 days
`401`	Missing or invalid credentials
`403`	Valid credentials, but missing `statistics:read`
`404`	Questionnaire not found or belongs to another organisation

Getting Started

External Pharmacy API

Management API

Scheduling API

Public API

Patient API

Anamnesis API

Webhooks

Guides

Questionnaires

Questionnaires

List Questionnaires

Example Request

Response

Response Fields

Get a Questionnaire

Example Request

Response

Response Fields

Error Responses

Create a Questionnaire

Example Request

Response

Error Responses

Update Questionnaire Metadata

Example Request

Response

Error Responses

Update Questionnaire Model

Example Request

Response

Error Responses

Questionnaire Submission Statistics

Example Request

Response

Response Fields

Error Responses

​Questionnaires

​List Questionnaires

​Example Request

​Response

​Response Fields

​Get a Questionnaire

​Example Request

​Response

​Response Fields

​Error Responses

​Create a Questionnaire

​Example Request

​Response

​Error Responses

​Update Questionnaire Metadata

​Example Request

​Response

​Error Responses

​Update Questionnaire Model

​Example Request

​Response

​Error Responses

​Questionnaire Submission Statistics

​Example Request

​Response

​Response Fields

​Error Responses

Questionnaires

List Questionnaires

Example Request

Response

Response Fields

Get a Questionnaire

Example Request

Response

Response Fields

Error Responses

Create a Questionnaire

Example Request

Response

Error Responses

Update Questionnaire Metadata

Example Request

Response

Error Responses

Update Questionnaire Model

Example Request

Response

Error Responses

Questionnaire Submission Statistics

Example Request

Response

Response Fields

Error Responses