protocols

Show a Protocol

Returns a protocol only when it is public.

get/api/protocols/{slug}

Request

  • Base URL: https://api.supp.co
  • URL: https://api.supp.co/api/protocols/{slug}
  • Auth: none required

Path parameters

slugstring required

Slug

Response

Successful operation

idstring uuid required
articlestring nullable required
article_htmlstring nullable required
created_atstring required
descriptionstring nullable required
description_htmlstring nullable required
health_goalstring required
image_urlstring nullable required
intended_forstring nullable required
intended_for_htmlstring nullable required
namestring required
other_itemsstring[] required
positioninteger nullable required
publicboolean nullable required
slugstring required
updated_atstring required
versioninteger nullable required
warningsstring nullable required
warnings_htmlstring nullable required

Example response

{
  "id": "def0a21f-b81a-4f28-a3be-2c55ddfed52a",
  "article": "SEO content here",
  "article_html": "<p>SEO content here</p>",
  "created_at": "2023-02-27T18:02:44.514Z",
  "demographics": {
    "ages": "all",
    "gender": "all"
  },
  "description": "A protocol for weight loss",
  "description_html": "<p>A protocol for weight loss</p>",
  "editor": {
    "name": "John Doe",
    "slug": "john-doe"
  },
  "health_goal": "Weight Loss",
  "name": "Weight Loss Protocol",
  "other_items": [
    "10g of Brazil Nuts, Twice Daily"
  ],
  "slug": "weight-loss-protocol",
  "updated_at": "2023-04-11T19:08:24.770Z",
  "version": 1,
  "versions": [
    {
      "version": 1,
      "prescriptions": [
        {
          "dosage_max": "6000.0",
          "dosage_max_per_day": 6000,
          "dosage_min": "4000.0",
          "dosage_min_per_day": 4000,
          "dosage_prefix": "Take",
          "dosage_suffix": "daily",
          "dosage_target": "5000.0",
          "dosage_target_per_day": 5000,
          "dosage_times_per_day": 1,
          "dosage_unit": "mcg",
          "supplement_name": "Vitamin D3",
          "supplement_slug": "vitamin-d3",
          "nutrient_id": "vitamin-d3",
          "nutrient_name": "Vitamin D3",
          "recommended_products": [
            {
              "position": 1,
              "product": {
                "brand_trust_score": "0.95"
              }
            }
          ],
          "supplement": {
            "name": "Vitamin D3",
            "slug": "vitamin-d3",
            "community_age_distribution": "{}",
            "community_gender_distribution": "{}",
            "community_goals_distribution": "{}",
            "units": "mcg",
            "nutrient_id": "vitamin-d3"
          },
          "nutrient": {
            "name": "Vitamin D3",
            "slug": "vitamin-d3",
            "community_age_distribution": "{}",
            "community_gender_distribution": "{}",
            "community_goals_distribution": "{}",
            "units": "mcg",
            "nutrient_id": "vitamin-d3"
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.