Skip to main content

List

The Library describes the questionnaires available to you; this endpoint returns the same catalogue programmatically. Use it to get the id of a questionnaire, which you need in order to read its content or activate it for a user.

  • Endpoint: https://api.withings.com/v2/survey
  • Method: POST
  • Parameters:
    • action: Use list.
    • client_id: Client ID.
    • signature: Signature.
    • nonce: Nonce.
    • offset: (optional) Used for pagination.

Run In Postman

The questionnaires will be returned in JSON format:

{
  "status": 0,
  "body": {
    "surveys": [
      {
        "id": 119,
        "name": "Hypertension Check-in",
        "description": "A series of questions that helps evaluating the lifestyle of your patient",
        "trigger_type": 1,
        "trigger_conditions": {
          "range": 2,
          "value": "1"
        },
        "category": 2,
        "answer_type": 1,
        "trigger_type_name": "periodic",
        "answer_type_name": "various_choice",
        "category_name": "behavior"
      },
      {
        "id": 120,
        "name": "Blood pressure crisis long version",
        "description": "A questionnaire triggered when reading are higher than 180/120",
        "trigger_type": 10,
        "trigger_conditions": [
          {
            "type": 10,
            "value": "180"
          },
          {
            "type": 9,
            "value": "120"
          }
        ],
        "category": 1,
        "answer_type": 1,
        "trigger_type_name": "threshold_above",
        "answer_type_name": "various_choice",
        "category_name": "symptom"
      }
    ],
    "more": false
  }
}