GET /ingredients

GET /ingredients

Returns Ingredients

Query parameters

  • page integer

    requested page number

    Minimum value is 1. Default value is 1.

  • page_size integer

    requested page size

    Minimum value is 1, maximum value is 100. Default value is 12.

  • prop_int_comedogenic_rating integer

    Filter by Property Comedogenic Rating

  • prop_bool_antioxidant boolean

    Filter by Property Antioxidant

  • prop_bool_moisturising boolean

    Filter by Property Moisturising

  • prop_bool_softening boolean

    Filter by Property Softening

  • prop_bool_soothing boolean

    Filter by Property Soothing

  • prop_bool_acne_fighting boolean

    Filter by Property Acne Fighting

  • prop_bool_anti_aging boolean

    Filter by Property Anti-Aging

  • prop_bool_healing boolean

    Filter by Property Healing

  • prop_bool_antiseptic boolean

    Filter by Property Antiseptic

  • prop_bool_whitening boolean

    Filter by Property Brightening

  • prop_bool_uv_protecting boolean

    Filter by Property UV Protecting

  • prop_bool_allergen boolean

    Filter by Property Allergen

  • prop_bool_alcohol boolean

    Filter by Property Alcohol

  • prop_bool_gluten boolean

    Filter by Property Gluten

  • prop_bool_silicone boolean

    Filter by Property Silicone

  • prop_bool_sulfate boolean

    Filter by Property Sulfate

  • prop_bool_paraben boolean

    Filter by Property Paraben

  • prop_bool_peg boolean

    Filter by Property PEG

  • prop_bool_fungal_acne_feeding boolean

    Filter by Property Fungal Acne Feeding

Responses

  • 200

    successful operation

    Hide response attributes Show response attributes object
    • data array[object]
      Hide data attributes Show data attributes array[object]
      • id integer
      • title string
      • alias string
      • description string
      • introtext string
      • content string
      • categories string
      • ewg object
        Hide ewg attributes Show ewg attributes object
        • min integer
        • max integer
        • data string
        • url string
        • background string
        • decision string
      • created_at string(DateTime)
      • updated_at string(DateTime)
      • cir_rating string
      • integer_properties object
        Hide integer_properties attributes Show integer_properties attributes object
        • comedogenic_rating integer
        • natural integer
      • boolean_properties object
        Hide boolean_properties attributes Show boolean_properties attributes object
        • ceramide boolean
        • vitamin boolean
        • pha boolean
        • bha boolean
        • aha boolean
        • hyaluronic_acid boolean
        • retinoid boolean
        • niacinamide boolean
        • antioxidant boolean
        • moisturising boolean
        • softening boolean
        • soothing boolean
        • acne_fighting boolean
        • anti_aging boolean
        • healing boolean
        • antiseptic boolean
        • whitening boolean
        • uv_protecting boolean
        • allergen boolean
        • alcohol boolean
        • gluten boolean
        • silicone boolean
        • sulfate boolean
        • paraben boolean
        • peg boolean
        • fungal_acne_feeding boolean
        • fragrance boolean
        • good_for_dry_skin boolean
        • bad_for_dry_skin boolean
        • good_for_oily_skin boolean
        • bad_for_oily_skin boolean
        • good_for_sensitive_skin boolean
        • bad_for_sensitive_skin boolean
    • links object
      Hide links attributes Show links attributes object
      • first string(url)
      • last string(url)
      • prev string(url)
      • next string(url)
  • 400

    Bad Request

  • 401

    Authorization information is missing or invalid.

  • 500

    Server Error

GET /ingredients 
curl \
 -X GET https://api.cosmily.com/api/v1/ingredients \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [
    {
      "id": 1,
      "title": "Water",
      "alias": "water",
      "status": "analyzed",
      "description": null,
      "introtext": "<p>#1 <strong>solvent</strong> in many skincare and haircare products. Usually, creams contain 40 - 70% of water, while toners and micellar water may have up to 90%. Manufacturers <strong>purify</strong> and <strong>deionize</strong> it before putting it into the product to make the formula last longer.</p> <p>As for the benefits, it is neither good nor bad. It's a neutral component itself, but it's a very important part of a product.</p>",
      "content": "",
      "categories": "Solvent",
      "ewg": {
        "min": 1,
        "max": 1,
        "data": "Robust",
        "url": "/skindeep/ingredient/706945/WATER/",
        "background": "bg-safe",
        "decision": "Safe - Moderate hazard"
      },
      "created_at": "2021-10-04T11:56:27.000Z",
      "updated_at": "2021-11-13T20:23:18.000Z",
      "cir_rating": "",
      "integer_properties": {
        "comedogenic_rating": 0,
        "natural": 1
      },
      "boolean_properties": {
        "ceramide": false,
        "vitamin": false,
        "pha": false,
        "bha": false,
        "aha": false,
        "hyaluronic_acid": false,
        "retinoid": false,
        "niacinamide": false,
        "antioxidant": false,
        "moisturising": false,
        "softening": false,
        "soothing": false,
        "acne_fighting": false,
        "anti_aging": false,
        "healing": false,
        "antiseptic": false,
        "whitening": false,
        "uv_protecting": false,
        "allergen": false,
        "alcohol": false,
        "gluten": false,
        "silicone": false,
        "sulfate": false,
        "paraben": false,
        "peg": false,
        "fungal_acne_feeding": false,
        "good_for_dry_skin": false,
        "bad_for_dry_skin": false,
        "good_for_oily_skin": false,
        "bad_for_oily_skin": false,
        "good_for_sensitive_skin": false,
        "bad_for_sensitive_skin": false
      }
    }
  ],
  "links": {
    "first": "/api/v1/ingredients?page=1",
    "last": "/api/v1/ingredients?page=1"
  }
}
Response examples (200) 
{
  "data": [
    {
      "id": 1,
      "ewg": {
        "max": 1,
        "min": 1,
        "url": "/skindeep/ingredient/706945/WATER/",
        "data": "Robust",
        "decision": "Safe - Moderate hazard",
        "background": "bg-safe"
      },
      "alias": "water",
      "title": "Water",
      "status": "analyzed",
      "content": "",
      "introtext": "<p>#1 <strong>solvent</strong> in many skincare and haircare products. Usually, creams contain 40 - 70% of water, while toners and micellar water may have up to 90%. Manufacturers <strong>purify</strong> and <strong>deionize</strong> it before putting it into the product to make the formula last longer.</p> <p>As for the benefits, it is neither good nor bad. It's a neutral component itself, but it's a very important part of a product.</p>",
      "categories": "Solvent",
      "cir_rating": "",
      "created_at": "2021-10-04T11:56:27.000Z",
      "updated_at": "2021-11-13T20:23:18.000Z",
      "description": null,
      "boolean_properties": {
        "aha": false,
        "bha": false,
        "peg": false,
        "pha": false,
        "gluten": false,
        "alcohol": false,
        "healing": false,
        "paraben": false,
        "sulfate": false,
        "vitamin": false,
        "allergen": false,
        "ceramide": false,
        "retinoid": false,
        "silicone": false,
        "soothing": false,
        "softening": false,
        "whitening": false,
        "anti_aging": false,
        "antiseptic": false,
        "antioxidant": false,
        "niacinamide": false,
        "moisturising": false,
        "acne_fighting": false,
        "uv_protecting": false,
        "hyaluronic_acid": false,
        "bad_for_dry_skin": false,
        "bad_for_oily_skin": false,
        "good_for_dry_skin": false,
        "good_for_oily_skin": false,
        "fungal_acne_feeding": false,
        "bad_for_sensitive_skin": false,
        "good_for_sensitive_skin": false
      },
      "integer_properties": {
        "natural": 1,
        "comedogenic_rating": 0
      }
    }
  ],
  "links": {
    "last": "/api/v1/ingredients?page=1",
    "first": "/api/v1/ingredients?page=1"
  }
}