products

List and search for Products

get/api/products

Request

  • Base URL: https://api.supp.co
  • URL: https://api.supp.co/api/products
  • Auth: none required

Query parameters

querystring

Search query for brand, name, supplements, or UPC

upcstring

Search query for UPC

upcsstring

Search query for multiple comma separated UPCs

amazonProductIDstring

Search query for Amazon Product ID

shopifyVariantIDstring

Search query for Shopify Variant ID

search_session_idstring

Client-minted id for one search session, shared with /api/products/filter and /api/shop/products. When present with query, the typeahead query is recorded into that session's product search row. Only query (and client_key when sent) is written, so the category, filters, sort and result count a /filter request set on the same row are kept. Omit it on page-load/prefetch requests.

client_keystring

Surface tag for the captured search (e.g. products). Kept on the row when a later request omits it. No effect without search_session_id.

Response

Successful operation

active_fda_recallboolean nullable required
active_fda_recall_bodystring nullable required
active_fda_recall_headerstring nullable required
active_fda_recall_urlstring nullable required
added_to_tested_by_suppco_atstring date-time nullable required
additional_category_idsstring[] required
archivedboolean nullable required
average_excipient_risk_ratingstring nullable required
best_valueboolean required
brandstring required
brand_active_fda_recallboolean nullable required
brand_idstring nullable required
brand_practitioner_grade_integrationboolean nullable required
brand_supple100boolean nullable required
brand_trust_scorestring nullable required

Decimal column serialized as a string (for example "0.95").

brand_trust_score_percentilestring nullable required

Decimal column serialized as a string (for example "0.95").

brand_trust_score_statestring nullable required
brand_trust_score_updated_atstring date-time nullable required
categorystring nullable required
category_namestring nullable required
certifiedboolean nullable required
contains_proprietary_blendboolean nullable required
country_of_manufacturestring nullable required
eurofins_certified_supplementboolean nullable required
eurofins_clean_sport_certifiedboolean nullable required
failed_any_testsboolean required
faq_questionsstring required

JSON-encoded array of FAQ entries (the raw jsonb column text, not a decoded array).

fda_warning_letter_urlstring nullable required
featuredboolean nullable required
formatstring nullable required
free_from_artificial_colors_flavors_fillersboolean nullable required
gluten_free_certifiedboolean nullable required
gluten_free_ingredientsboolean nullable required
health_goalsstring[] nullable required
heavy_metals_testingstring nullable required
heavy_metals_testing_public_explanationstring nullable required
idstring uuid required
identity_potency_testingstring nullable required
identity_potency_testing_public_explanationstring nullable required
igen_non_gmo_testedboolean nullable required
image_urlstring nullable required
informed_choice_certifiedboolean nullable required
informed_sport_certifiedboolean nullable required
intro_paragraphstring nullable required
label_urlstring nullable required
mislabeled_principal_display_panelboolean nullable required
most_popularboolean required
most_trustedboolean required
msrpstring nullable required

Decimal column serialized as a string (for example "0.95").

namestring required
non_gmo_certifiedboolean nullable required
non_gmo_ingredientsboolean nullable required
nsf_certified_for_sportboolean nullable required
nsf_contents_certifiedboolean nullable required
off_marketboolean nullable required
organic_ingredientsboolean nullable required
other_ingredientsstring nullable required
patented_or_trademarked_ingredientsboolean nullable required
pricestring nullable required

Decimal column serialized as a string (for example "0.95").

price_per_servingstring nullable required

Decimal column serialized as a string (for example "0.95").

price_per_serving_percentile_in_categorynumber nullable required
product_linestring nullable required
product_trust_scorestring nullable required

Decimal column serialized as a string (for example "0.95").

product_trust_score_completeboolean nullable required
product_trust_score_complete_atstring date-time nullable required
product_trust_score_percentile_in_categorynumber nullable required
product_trust_score_statusstring required
received_fda_warning_letterboolean nullable required
resolved_fda_warning_letterboolean required
serving_sizestring nullable required
servings_per_containernumber nullable required
similar_productsobject[] required

Currently always empty: ProductSerializer.find_all assigns an empty array to every product.

slugstring nullable required
stacks_count_percentile_in_categorynumber nullable required
suggested_usestring nullable required
suppco_testing_headlinestring nullable required
suppco_testing_sub_headerstring nullable required
supplement_countinteger nullable required
supplement_namesstring[] nullable required
tested_by_suppcoboolean nullable required
transparent_batch_specific_coasboolean required
trending_percentage_30dnumber nullable required
trust_clinical_study_urlstring nullable required
trust_clinical_study_url2string nullable required
trust_clinical_study_url3string nullable required
trust_clinically_studied_productboolean nullable required
trust_score_suppressedboolean required
upcstring nullable required
usda_organic_certifiedboolean nullable required
usp_verifiedboolean nullable required
validatedboolean nullable required
vegan_action_certifiedboolean nullable required
vegan_friendly_ingredientsboolean nullable required

Changes

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