Skip to main content

Listing Health Campaigns

Now that we have created our first campaign, we can use te list action to retrieve a list of all the campaigns we created.

Endpoint Details

  • Endpoint: https://wbsapi.withings.net/v2/nudgecampaign
  • Method: POST

Parameters

  • action: Use list to retrieve a comprehensive list of campaigns.
  • Authentication parameters: signature, client_id, nonce.

Run In Postman

Example Request for Listing Campaigns

To fetch a list of all your nudge campaigns:

{
    "action": "list",
    "signature": "generated_signature",
    "client_id": "YourClientID",
    "nonce": "UniqueNonceValue"
}

Response from the API:

{
    "status": 0,
    "body": {
        "campaigns": [
          {
            "id": 3,
            "nudgeid": 4,
            "max_display_count": 5,
            "startdate": 1712106335,
            "enddate": 1735689600,
            "user_count": 0,
            "created": 1712016369,
            "modified": 1712016369
          }
        ]
    }
}

This request will return details of all campaigns you've created, including their IDs, status (active or past), start and end dates, and associated nudges.