API Reference
Flavor Studio’s API has predictable, resource-oriented URLs, and uses JSON to indicate API errors. To authenticate it uses HTTP Basic Auth. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your private API key in any public website's client-side code). JSON is returned by all API responses, including errors.
Authentication
You access the Flavor Studio API using API keys that represent the required credentials. Authenticate your organization when using the API by including your API public and API private keys in the request. You can generate API keys by enabling the API on the Settings tab of the Admin page in Flavor Studio. Do not share your secret API keys in publicly accessible areas such GitHub, client-side code, and so forth. Since API Keys can be independently revoked, you have complete control of the lifecycle of your API credentials. Disabling the API from the Settings tab will permanently delete your API keys and render them unusable.
Flavor Studio generates a new public and private key pair each time that the API is enabled.
Authentication to the API is performed via HTTP Basic Auth. Provide your public API key as the Basic Auth username value and private API key as Basic Auth password value.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Projects
API section for projects.
Listing
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/projects
URL Parameters
Parameter |
Type |
Status |
Description |
page |
integer |
optional |
Sets the page. Default: 1 |
step |
integer |
optional |
Defines how many results are listed for the current page. Default: 10, Max Value: 1000 |
order |
string |
optional |
Enum [project_uid, project_name, start_date, end_date, project_description, project_status, priority, volume_lbs, revenue, approved, approval_date, created, modified] |
odirection |
string |
optional |
Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc |
filter |
string |
optional |
Filter results by keyword. |
datefilter |
date [YYYY-MM-DD] |
optional |
Filter results by date. |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: projects. |
projects |
array |
Project details are listed here. Each project contains the overview data, stages, tasks, repository files and folders. |
projects_total |
integer |
Returns of total number of projects based on filters. |
page |
integer |
Returns a requested page. |
step |
integer |
Returns a requested step. |
filter |
string |
Returns a requested filter keyword. |
datefilter |
string |
Returns a requested date. Returns empty value or date in YYYY-MM-DD format. |
order |
string |
Returns a requested order field. |
odirection |
string |
Returns a requested order direction. [asc, desc] |
api_version |
integer |
Returns a requested api version. [1, 2] |
Get Project
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/project/{id}
URL Parameters
Parameter |
Type |
Status |
Description |
id |
integer |
required |
Set the project unique id |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: projects. |
section_uid |
integer |
Project ID |
action |
string |
[get] |
data |
array |
Project details are listed here. |
api_version |
integer |
Returns a requested api version. [1, 2] |
Recipes
API section for recipes.
Listing
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/recipes
URL Parameters
Parameter |
Type |
Status |
Description |
user |
string |
optional |
Defines the user's email address, for example test@test.com. |
page |
integer |
optional |
Sets the page. Default: 1 |
step |
integer |
optional |
Defines how many results are listed for the current page. Default: 10, Max Value: 1000 |
order |
string |
optional |
Enum [unique_id, recipe_name, created, last_modified] |
odirection |
string |
optional |
Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc |
filter |
string |
optional |
Filter results by keyword. |
datefilter |
date [YYYY-MM-DD] |
optional |
Filter results by date. |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: recipes. |
recipes |
array |
Recipe details are listed here. |
recipe_total |
integer |
Returns of total number of recipes based on filters. |
page |
integer |
Returns a requested page. |
step |
integer |
Returns a requested step. |
filter |
string |
Returns a requested filter keyword. |
datefilter |
string |
Returns a requested date. Returns empty value or date in YYYY-MM-DD format. |
order |
string |
Returns a requested order field. |
odirection |
string |
Returns a requested order direction. [asc, desc] |
user_name |
string |
Returns a requested user's name. |
user_email |
string |
Returns a requested user's email address. |
api_version |
integer |
Returns a requested api version. [1, 2] |
Get Recipe
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/recipe/{id}/region/us/dv/adult/quantities/100g-sample
URL Parameters
Parameter |
Type |
Status |
Description |
id |
integer |
required |
Set the recipe Unique ID |
region |
string |
optional |
Set the Composition rounding region. Can be "us" or "canada". Default value is "us". |
dv |
string |
optional |
Set a daily value calculation method. In case of "us" region the DV% values can be "adult", "children", "infant" or "pregnant-women". In case of "canada" region the DV% value can be "adult", "children" or "infant". Default value is "adult"; |
quantities |
string |
optional |
Set the total quantity for composition calculation which can be "serving-size" or "100g-sample". Default value is "serving-size"; |
values |
string |
optional |
Set the nutrient quantity rounding method which can be "unrounded", "rounded" or "rounded_restaurant". Default value is "rounded"; |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: recipes. |
section_uid |
integer |
Recipe Unique ID |
action |
string |
[get] |
data |
array |
Recipe details are listed here. |
region |
string |
Returns a requested region. ["us", "canada"] |
dv |
string |
Returns a requested DV% value. ["adult", "children", "infant", "pregnant-women"] |
quantities |
string |
Returns a requested quantity value. ["serving-size", "100g-sample"] |
values |
string |
Returns a requested quantity value rounding method. ["unrounded", "rounded", "rounded_restaurant"] |
api_version |
integer |
Returns a requested api version. [1, 2] |
Ingredients
API section for recipe ingredients.
Listing
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/ingredients
URL Parameters
Parameter |
Type |
Status |
Description |
page |
integer |
optional |
Sets the page. Default: 1 |
step |
integer |
optional |
Defines how many results are listed for the current page. Default: 10, Max Value: 1000 |
order |
string |
optional |
Enum [name, ingredientcost_code, category_name, manufacturer, ingredientcost_cost, created] |
odirection |
string |
optional |
Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc |
filter |
string |
optional |
Filter results by keyword. |
datefilter |
date [YYYY-MM-DD] |
optional |
Filter results by date. |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: ingredients. |
ingredients |
array |
Ingredient details are listed here. |
ingredients_total |
integer |
Returns of total number of ingredients based on filters. |
page |
integer |
Returns a requested page. |
step |
integer |
Returns a requested step. |
filter |
string |
Returns a requested filter keyword. |
datefilter |
string |
Returns a requested date. Returns empty value or date in YYYY-MM-DD format. |
order |
string |
Returns a requested order field. |
odirection |
string |
Returns a requested order direction. [asc, desc] |
api_version |
integer |
Returns a requested api version. [1, 2] |
Get Ingredient
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/ingredient/{id}
URL Parameters
Parameter |
Type |
Status |
Description |
id |
integer[-]integer |
required |
Set the ingredient unique id |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: ingredients. |
section_uid |
integer[-]integer |
Ingredient ID |
action |
string |
[get] |
data |
array |
Ingredient details are listed here. |
api_version |
integer |
Returns a requested api version. [1, 2] |
Update Ingredient
Requires Authentication
HTTP Request
POSThttps://app.flavorstudio.com/api/v2/update/ingredient/{id}
URL Parameters
Parameter |
Type |
Status |
Description |
id |
integer[-]integer |
required |
Set the ingredient unique id |
Body Parameters
Parameter |
Type |
Status |
Description |
ingredient |
string |
required |
Ingredient name |
item_code |
string |
required |
Cost Code |
cost |
float |
required |
$ Price |
quantity |
float |
required |
Cost Quantity |
unit |
string |
required |
Cost Unit. Enum [kg, g, mg, mcg, oz, lbs, l, ml, tsp, tbsp, fl_oz, cup, pt, qt, gal, each] |
yield |
float |
required |
Yield percentage |
fob_terms |
string |
required |
FOB terms. Enum ["Customer pickup", "Destination, freight prepaid", "Destination, freight collect", "Destination, freight collect and allowed", "Origin, freight prepaid", "Origin, freight collect", "Origin, freight prepaid and charged back", "Destination, freight prepaid and charged back"] |
minimum_order_info |
string |
required |
Minimum Order Info |
category |
string |
required |
Ingredient category |
supplier |
string |
required |
Supplier |
ingredient_statement |
string |
required |
Ingredient statement |
canadian_ingredient_statement |
string |
required |
Ingredient statement (french) |
density_weight |
float |
required |
Density weight |
density_weight_unit |
string |
required |
Density weight unit [g, kg, mg, lbs, oz] |
density_unit |
string |
required |
Density volume unit [ml, l, tsp, tbsp, fl_oz, cup, pt, qt, gal] |
processing_aid |
integer |
required |
Processing Aid [0,1] |
notes |
string |
required |
Notes |
weight_g |
float |
required |
Weight (g). Default: 100 |
calories_kcal |
float |
required |
Calories (kcal) |
total_fat_g |
float |
required |
Total fat (g) |
saturated_fat_g |
float |
required |
Saturated fat (g) |
trans_fatty_acid_g |
float |
required |
Trans fatty acid (g) |
cholesterol_mg |
float |
required |
Cholesterol (mg) |
sodium_mg |
float |
required |
Sodium (mg) |
total_carbohydrate_g |
float |
required |
Total Carbohydrate (g) |
dietary_fiber_g |
float |
required |
Dietary Fiber (g) |
total_sugars_g |
float |
required |
Total sugars (g) |
added_sugars_g |
float |
required |
Added sugars (g) |
protein_g |
float |
required |
Protein (g) |
water_g |
float |
required |
Water (g) |
ash_g |
float |
required |
Ash (g) |
vitamin_a_iu |
float |
required |
Vitamin A (IU) |
vitamin_a_rae_mcg |
float |
required |
Vitamin A (RAE) (mcg) |
thiamin_mg |
float |
required |
Thiamin/B1 (mg) |
riboflavin_mg |
float |
required |
Riboflavin/B2 (mg) |
niacin_mg |
float |
required |
Niacin/B3 (mg) |
vitamin_b6_mg |
float |
required |
Vitamin B6 (mg) |
vitamin_b12_mcg |
float |
required |
Vitamin B12 (mcg) |
vitamin_c_mg |
float |
required |
Vitamin C (mg) |
vitamin_d_iu |
float |
required |
Vitamin D (IU) |
vitamin_d_mcg |
float |
required |
Vitamin D (mcg) |
vitamin_e_mg |
float |
required |
Vitamin E (mg) |
vitamin_k_mcg |
float |
required |
Vitamin K (mcg) |
beta_carotene_mcg |
float |
required |
Beta-carotene (mcg) |
biotin_mcg |
float |
required |
Biotin/B7 (mcg) |
food_folate_mcg |
float |
required |
Food folate (mcg) |
folate_mcg |
float |
required |
Folate/B9 (mcg) |
folate_dfe_mcg |
float |
required |
Folate/B9 (DFE) (mcg) |
pantothenic_acid_mg |
float |
required |
Pantothenic acid (mg) |
retinol_mcg |
float |
required |
Retinol (mcg) |
calcium_mg |
float |
required |
Calcium (mg) |
chloride_mg |
float |
required |
Chloride (mg) |
chromium_mcg |
float |
required |
Chromium (mcg) |
copper_mg |
float |
required |
Copper (mg) |
iron_mg |
float |
required |
Iron (mg) |
magnesium_mg |
float |
required |
Magnesium (mg) |
manganese_mg |
float |
required |
Manganese (mg) |
molybdenum_mcg |
float |
required |
Molybdenum (mcg) |
phosphorus_mg |
float |
required |
Phosphorus (mg) |
potassium_mg |
float |
required |
Potassium (mg) |
selenium_mcg |
float |
required |
Selenium (mcg) |
zinc_mg |
float |
required |
Zinc (mg) |
monounsaturated_g |
float |
required |
Monounsaturated (g) |
polyunsaturated_g |
float |
required |
Polyunsaturated (g) |
omega_3_g |
float |
required |
Omega-3 (g) |
omega_6_g |
float |
required |
Omega-6 (g) |
alcohol_ethyl_g |
float |
required |
Alcohol, ethyl (g) |
alpha_carotene_mcg |
float |
required |
Alpha-carotene (mcg) |
beta_cryptoxanthin_mcg |
float |
required |
Beta-cryptoxanthin (mcg) |
caffeine_mg |
float |
required |
Caffeine (mg) |
choline_mg |
float |
required |
Choline (mg) |
fluoride_mg |
float |
required |
Fluoride (mg) |
folic_acid_mcg |
float |
required |
Folic acid (mcg) |
lutein_zeazanthin_mcg |
float |
required |
Lutein+zeazanthin (mcg) |
lycopene_mcg |
float |
required |
Lycopene (mcg) |
iodine_mcg |
float |
required |
Iodine (mcg) |
sugar_alcohol_g |
float |
required |
Sugar Alcohol (g) |
allergen_egg |
string |
required |
Enum [Yes, No] |
allergen_peanuts |
string |
required |
Enum [Yes, No] |
allergen_milk |
string |
required |
Enum [Yes, No] |
allergen_wheat |
string |
required |
Enum [Yes, No] |
allergen_soy |
string |
required |
Enum [Yes, No] |
allergen_tree_nuts |
string |
required |
Enum [Yes, No, custom value] |
allergen_fish |
string |
required |
Enum [Yes, No, custom value] |
allergen_shellfish |
string |
required |
Enum [Yes, No, custom value] |
allergen_mustard |
string |
required |
Enum [Yes, No] |
allergen_sesame_seeds |
string |
required |
Enum [Yes, No] |
allergen_sulfites |
string |
required |
Enum [Yes, No] |
allergen_gluten |
string |
required |
Enum [Yes, No] |
maycontain_egg |
string |
required |
Enum [Yes, No] |
maycontain_peanuts |
string |
required |
Enum [Yes, No] |
maycontain_milk |
string |
required |
Enum [Yes, No] |
maycontain_wheat |
string |
required |
Enum [Yes, No] |
maycontain_soy |
string |
required |
Enum [Yes, No] |
maycontain_tree_nuts |
string |
required |
Enum [Yes, No, custom value] |
maycontain_fish |
string |
required |
Enum [Yes, No, custom value] |
maycontain_shellfish |
string |
required |
Enum [Yes, No, custom value] |
maycontain_mustard |
string |
required |
Enum [Yes, No] |
maycontain_sesame_seeds |
string |
required |
Enum [Yes, No] |
maycontain_sulfites |
string |
required |
Enum [Yes, No] |
maycontain_gluten |
string |
required |
Enum [Yes, No] |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: ingredients. |
section_uid |
integer[-]integer |
Updated ingredient ID |
action |
string |
[update] |
success |
boolean |
[true, false] |
data |
array |
Updated ingredient data. |
errors |
array |
Contains error messages. |
api_version |
integer |
Returns a requested api version. [1, 2] |
Create Ingredient
Requires Authentication
HTTP Request
POSThttps://app.flavorstudio.com/api/v2/create/ingredient/
Body Parameters
Parameter |
Type |
Status |
Description |
ingredient |
string |
required |
Ingredient name |
item_code |
string |
required |
Cost Code |
cost |
float |
required |
$ Price |
quantity |
float |
required |
Cost Quantity |
unit |
string |
required |
Cost Unit. Enum [kg, g, mg, mcg, oz, lbs, l, ml, tsp, tbsp, fl_oz, cup, pt, qt, gal, each] |
yield |
float |
required |
Yield percentage |
fob_terms |
string |
required |
FOB terms. Enum ["Customer pickup", "Destination, freight prepaid", "Destination, freight collect", "Destination, freight collect and allowed", "Origin, freight prepaid", "Origin, freight collect", "Origin, freight prepaid and charged back", "Destination, freight prepaid and charged back"] |
minimum_order_info |
string |
required |
Minimum Order Info |
category |
string |
required |
Ingredient category |
supplier |
string |
required |
Supplier |
ingredient_statement |
string |
required |
Ingredient statement |
canadian_ingredient_statement |
string |
required |
Ingredient statement (french) |
density_weight |
float |
required |
Density weight |
density_weight_unit |
string |
required |
Density weight unit [g, kg, mg, lbs, oz] |
density_unit |
string |
required |
Density volume unit [ml, l, tsp, tbsp, fl_oz, cup, pt, qt, gal] |
processing_aid |
integer |
required |
Processing Aid [0,1] |
notes |
string |
required |
Notes |
weight_g |
float |
required |
Weight (g). Default: 100 |
calories_kcal |
float |
required |
Calories (kcal) |
total_fat_g |
float |
required |
Total fat (g) |
saturated_fat_g |
float |
required |
Saturated fat (g) |
trans_fatty_acid_g |
float |
required |
Trans fatty acid (g) |
cholesterol_mg |
float |
required |
Cholesterol (mg) |
sodium_mg |
float |
required |
Sodium (mg) |
total_carbohydrate_g |
float |
required |
Total Carbohydrate (g) |
dietary_fiber_g |
float |
required |
Dietary Fiber (g) |
total_sugars_g |
float |
required |
Total sugars (g) |
added_sugars_g |
float |
required |
Added sugars (g) |
protein_g |
float |
required |
Protein (g) |
water_g |
float |
required |
Water (g) |
ash_g |
float |
required |
Ash (g) |
vitamin_a_iu |
float |
required |
Vitamin A (IU) |
vitamin_a_rae_mcg |
float |
required |
Vitamin A (RAE) (mcg) |
thiamin_mg |
float |
required |
Thiamin/B1 (mg) |
riboflavin_mg |
float |
required |
Riboflavin/B2 (mg) |
niacin_mg |
float |
required |
Niacin/B3 (mg) |
vitamin_b6_mg |
float |
required |
Vitamin B6 (mg) |
vitamin_b12_mcg |
float |
required |
Vitamin B12 (mcg) |
vitamin_c_mg |
float |
required |
Vitamin C (mg) |
vitamin_d_iu |
float |
required |
Vitamin D (IU) |
vitamin_d_mcg |
float |
required |
Vitamin D (mcg) |
vitamin_e_mg |
float |
required |
Vitamin E (mg) |
vitamin_k_mcg |
float |
required |
Vitamin K (mcg) |
beta_carotene_mcg |
float |
required |
Beta-carotene (mcg) |
biotin_mcg |
float |
required |
Biotin/B7 (mcg) |
food_folate_mcg |
float |
required |
Food folate (mcg) |
folate_mcg |
float |
required |
Folate/B9 (mcg) |
folate_dfe_mcg |
float |
required |
Folate/B9 (DFE) (mcg) |
pantothenic_acid_mg |
float |
required |
Pantothenic acid (mg) |
retinol_mcg |
float |
required |
Retinol (mcg) |
calcium_mg |
float |
required |
Calcium (mg) |
chloride_mg |
float |
required |
Chloride (mg) |
chromium_mcg |
float |
required |
Chromium (mcg) |
copper_mg |
float |
required |
Copper (mg) |
iron_mg |
float |
required |
Iron (mg) |
magnesium_mg |
float |
required |
Magnesium (mg) |
manganese_mg |
float |
required |
Manganese (mg) |
molybdenum_mcg |
float |
required |
Molybdenum (mcg) |
phosphorus_mg |
float |
required |
Phosphorus (mg) |
potassium_mg |
float |
required |
Potassium (mg) |
selenium_mcg |
float |
required |
Selenium (mcg) |
zinc_mg |
float |
required |
Zinc (mg) |
monounsaturated_g |
float |
required |
Monounsaturated (g) |
polyunsaturated_g |
float |
required |
Polyunsaturated (g) |
omega_3_g |
float |
required |
Omega-3 (g) |
omega_6_g |
float |
required |
Omega-6 (g) |
alcohol_ethyl_g |
float |
required |
Alcohol, ethyl (g) |
alpha_carotene_mcg |
float |
required |
Alpha-carotene (mcg) |
beta_cryptoxanthin_mcg |
float |
required |
Beta-cryptoxanthin (mcg) |
caffeine_mg |
float |
required |
Caffeine (mg) |
choline_mg |
float |
required |
Choline (mg) |
fluoride_mg |
float |
required |
Fluoride (mg) |
folic_acid_mcg |
float |
required |
Folic acid (mcg) |
lutein_zeazanthin_mcg |
float |
required |
Lutein+zeazanthin (mcg) |
lycopene_mcg |
float |
required |
Lycopene (mcg) |
iodine_mcg |
float |
required |
Iodine (mcg) |
sugar_alcohol_g |
float |
required |
Sugar Alcohol (g) |
allergen_egg |
string |
required |
Enum [Yes, No] |
allergen_peanuts |
string |
required |
Enum [Yes, No] |
allergen_milk |
string |
required |
Enum [Yes, No] |
allergen_wheat |
string |
required |
Enum [Yes, No] |
allergen_soy |
string |
required |
Enum [Yes, No] |
allergen_tree_nuts |
string |
required |
Enum [Yes, No, custom value] |
allergen_fish |
string |
required |
Enum [Yes, No, custom value] |
allergen_shellfish |
string |
required |
Enum [Yes, No, custom value] |
allergen_mustard |
string |
required |
Enum [Yes, No] |
allergen_sesame_seeds |
string |
required |
Enum [Yes, No] |
allergen_sulfites |
string |
required |
Enum [Yes, No] |
allergen_gluten |
string |
required |
Enum [Yes, No] |
maycontain_egg |
string |
required |
Enum [Yes, No] |
maycontain_peanuts |
string |
required |
Enum [Yes, No] |
maycontain_milk |
string |
required |
Enum [Yes, No] |
maycontain_wheat |
string |
required |
Enum [Yes, No] |
maycontain_soy |
string |
required |
Enum [Yes, No] |
maycontain_tree_nuts |
string |
required |
Enum [Yes, No, custom value] |
maycontain_fish |
string |
required |
Enum [Yes, No, custom value] |
maycontain_shellfish |
string |
required |
Enum [Yes, No, custom value] |
maycontain_mustard |
string |
required |
Enum [Yes, No] |
maycontain_sesame_seeds |
string |
required |
Enum [Yes, No] |
maycontain_sulfites |
string |
required |
Enum [Yes, No] |
maycontain_gluten |
string |
required |
Enum [Yes, No] |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: ingredients. |
section_uid |
integer[-]integer |
Newly created ingredient ID |
action |
string |
[create] |
success |
boolean |
[true, false] |
data |
array |
Newly created ingredient data. |
errors |
array |
Contains error messages. |
api_version |
integer |
Returns a requested api version. [1, 2] |
Taste Tests
API section for projects.
Listing
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/tastetests
URL Parameters
Parameter |
Type |
Status |
Description |
user |
string |
optional |
Defines the user's email address, for example test@test.com. |
page |
integer |
optional |
Sets the page. Default: 1 |
step |
integer |
optional |
Defines how many results are listed for the current page. Default: 10, Max Value: 1000 |
order |
string |
optional |
Enum [tastetest_uid, tastetest_status, tastetest_name, tastetest_date, tastetest_start_time, tastetest_end_time, tastetest_description, tastetest_location, created] |
odirection |
string |
optional |
Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc |
filter |
string |
optional |
Filter results by keyword. |
datefilter |
date [YYYY-MM-DD] |
optional |
Filter results by date. |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: tastetests. |
tastetests |
array |
Taste Test details are listed here. |
tastetests_total |
integer |
Returns of total number of taste tests based on filters. |
page |
integer |
Returns a requested page. |
step |
integer |
Returns a requested step. |
filter |
string |
Returns a requested filter keyword. |
datefilter |
string |
Returns a requested date. Returns empty value or date in YYYY-MM-DD format. |
order |
string |
Returns a requested order field. |
odirection |
string |
Returns a requested order direction. [asc, desc] |
user_name |
string |
Returns a requested user's name. |
user_email |
string |
Returns a requested user's email address. |
api_version |
integer |
Returns a requested api version. [1, 2] |
Get Taste Test
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/tastetest/{id}
URL Parameters
Parameter |
Type |
Status |
Description |
id |
integer |
required |
Set the taste test unique id |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: tastetests. |
section_uid |
integer |
Taste Test ID |
action |
string |
[get] |
data |
array |
Taste test details are listed here. |
api_version |
integer |
Returns a requested api version. [1, 2] |
CRM Customers
API section for CRM Customers.
Listing
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/customers/
URL Parameters
Parameter |
Type |
Status |
Description |
page |
integer |
optional |
Sets the page. Default: 1 |
step |
integer |
optional |
Defines how many results are listed for the current page. Default: 10, Max Value: 1000 |
order |
string |
optional |
Enum [id, account_name, customer_name, business_type, business_market_segment, contract_start_date, contract_end_date, created, modified] |
odirection |
string |
optional |
Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc |
filter |
string |
optional |
Filter results by keyword. |
datefilter |
date [YYYY-MM-DD] |
optional |
Filter results by date. |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: crm. |
sub_section |
string |
Returns a requested CRM sub-section: customers. |
customers |
array |
CRM customer details are listed here. |
customers_total |
integer |
Returns of total number of CRM customers based on filters. |
page |
integer |
Returns a requested page. |
step |
integer |
Returns a requested step. |
filter |
string |
Returns a requested filter keyword. |
datefilter |
string |
Returns a requested date. Returns empty value or date in YYYY-MM-DD format. |
order |
string |
Returns a requested order field. |
odirection |
string |
Returns a requested order direction. [asc, desc] |
api_version |
integer |
Returns a requested api version. [1, 2] |
Get Customer
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/customer/{id}
URL Parameters
Parameter |
Type |
Status |
Description |
id |
integer |
required |
Set the customer unique id |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: crm. |
sub_section |
string |
Returns a requested CRM sub-section: customers. |
section_uid |
integer |
Customer ID |
action |
string |
[get] |
data |
array |
Customer details are listed here. |
api_version |
integer |
Returns a requested api version. [1, 2] |
CRM Opportunities
API section for CRM Customers.
Listing
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/opportunities/
URL Parameters
Parameter |
Type |
Status |
Description |
page |
integer |
optional |
Sets the page. Default: 1 |
step |
integer |
optional |
Defines how many results are listed for the current page. Default: 10, Max Value: 1000 |
order |
string |
optional |
Enum [id, opportunity_name, product, annualized_pounds, annualized_rev, stage, probability_of_sale, start_date, close_date, created, modified, crm_customer] |
odirection |
string |
optional |
Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc |
filter |
string |
optional |
Filter results by keyword. |
datefilter |
date [YYYY-MM-DD] |
optional |
Filter results by date. |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: crm. |
sub_section |
string |
Returns a requested CRM sub-section: opportunities. |
opportunities |
array |
CRM opportunity details are listed here. |
opportunities_total |
integer |
Returns of total number of CRM opportunities based on filters. |
page |
integer |
Returns a requested page. |
step |
integer |
Returns a requested step. |
filter |
string |
Returns a requested filter keyword. |
datefilter |
string |
Returns a requested date. Returns empty value or date in YYYY-MM-DD format. |
order |
string |
Returns a requested order field. |
odirection |
string |
Returns a requested order direction. [asc, desc] |
api_version |
integer |
Returns a requested api version. [1, 2] |
Get Opportunity
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/opportunity/{id}
URL Parameters
Parameter |
Type |
Status |
Description |
id |
integer |
required |
Set the opportunity unique id |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: crm. |
sub_section |
string |
Returns a requested CRM sub-section: opportunities. |
section_uid |
integer |
Opportunity ID |
action |
string |
[get] |
data |
array |
Opportunity details are listed here. |
api_version |
integer |
Returns a requested api version. [1, 2] |
CRM Contracts
API section for CRM Contracts.
Contract Listing
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/contracts/
URL Parameters
Parameter |
Type |
Status |
Description |
page |
integer |
optional |
Sets the page. Default: 1 |
step |
integer |
optional |
Defines how many results are listed for the current page. Default: 10, Max Value: 1000 |
order |
string |
optional |
Enum [id, contract_name, account_type, product_type, product, annualized_pounds, annualized_rev, contract_start_date, contract_end_date, created, modified, crm_customer] |
odirection |
string |
optional |
Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc |
filter |
string |
optional |
Filter results by keyword. |
datefilter |
date [YYYY-MM-DD] |
optional |
Filter results by date. |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: crm. |
sub_section |
string |
Returns a requested CRM sub-section: contracts. |
contracts |
array |
CRM contract details are listed here. |
contracts_total |
integer |
Returns of total number of CRM contracts based on filters. |
page |
integer |
Returns a requested page. |
step |
integer |
Returns a requested step. |
filter |
string |
Returns a requested filter keyword. |
datefilter |
string |
Returns a requested date. Returns empty value or date in YYYY-MM-DD format. |
order |
string |
Returns a requested order field. |
odirection |
string |
Returns a requested order direction. [asc, desc] |
api_version |
integer |
Returns a requested api version. [1, 2] |
Get Contract
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/contract/{id}
URL Parameters
Parameter |
Type |
Status |
Description |
id |
integer |
required |
Set the contract unique id |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: crm. |
sub_section |
string |
Returns a requested CRM sub-section: contracts. |
section_uid |
integer |
Contract ID |
action |
string |
[get] |
data |
array |
Contract details are listed here. |
api_version |
integer |
Returns a requested api version. [1, 2] |
CRM Activities
API section for CRM Activities.
Listing
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/activities/
URL Parameters
Parameter |
Type |
Status |
Description |
page |
integer |
optional |
Sets the page. Default: 1 |
step |
integer |
optional |
Defines how many results are listed for the current page. Default: 10, Max Value: 1000 |
order |
string |
optional |
Enum [id, activity_type, activity_date, created, modified] |
odirection |
string |
optional |
Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc |
filter |
string |
optional |
Filter results by keyword. |
datefilter |
date [YYYY-MM-DD] |
optional |
Filter results by date. |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: crm. |
sub_section |
string |
Returns a requested CRM sub-section: activities. |
activities |
array |
CRM activity details are listed here. |
activities_total |
integer |
Returns of total number of CRM activities based on filters. |
page |
integer |
Returns a requested page. |
step |
integer |
Returns a requested step. |
filter |
string |
Returns a requested filter keyword. |
datefilter |
string |
Returns a requested date. Returns empty value or date in YYYY-MM-DD format. |
order |
string |
Returns a requested order field. |
odirection |
string |
Returns a requested order direction. [asc, desc] |
api_version |
integer |
Returns a requested api version. [1, 2] |
Get Activity
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/activity/{id}
URL Parameters
Parameter |
Type |
Status |
Description |
id |
integer |
required |
Set the activity unique id |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: crm. |
sub_section |
string |
Returns a requested CRM sub-section: activities. |
section_uid |
integer |
Activity ID |
action |
string |
[get] |
data |
array |
Activity details are listed here. |
api_version |
integer |
Returns a requested api version. [1, 2] |
CRM Contacts
API section for CRM Contacts.
Listing
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/contacts/
URL Parameters
Parameter |
Type |
Status |
Description |
page |
integer |
optional |
Sets the page. Default: 1 |
step |
integer |
optional |
Defines how many results are listed for the current page. Default: 10, Max Value: 1000 |
order |
string |
optional |
Enum [id, contact_name, created, modified, crm_customer, crm_contract] |
odirection |
string |
optional |
Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc |
filter |
string |
optional |
Filter results by keyword. |
datefilter |
date [YYYY-MM-DD] |
optional |
Filter results by date. |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: crm. |
sub_section |
string |
Returns a requested CRM sub-section: contacts. |
contacts |
array |
CRM contact details are listed here. |
contacts_total |
integer |
Returns of total number of CRM contacts based on filters. |
page |
integer |
Returns a requested page. |
step |
integer |
Returns a requested step. |
filter |
string |
Returns a requested filter keyword. |
datefilter |
string |
Returns a requested date. Returns empty value or date in YYYY-MM-DD format. |
order |
string |
Returns a requested order field. |
odirection |
string |
Returns a requested order direction. [asc, desc] |
api_version |
integer |
Returns a requested api version. [1, 2] |
Get Contact
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/contact/{id}
URL Parameters
Parameter |
Type |
Status |
Description |
id |
integer |
required |
Set the contact unique id |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: crm. |
sub_section |
string |
Returns a requested CRM sub-section: contacts. |
section_uid |
integer |
Contact ID |
action |
string |
[get] |
data |
array |
Contact details are listed here. |
api_version |
integer |
Returns a requested api version. [1, 2] |
CRM Products
API section for CRM Products.
Listing
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/products/
URL Parameters
Parameter |
Type |
Status |
Description |
page |
integer |
optional |
Sets the page. Default: 1 |
step |
integer |
optional |
Defines how many results are listed for the current page. Default: 10, Max Value: 1000 |
order |
string |
optional |
Enum [id, item_code, product_name, product_type, discontinued, created, modified] |
odirection |
string |
optional |
Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc |
filter |
string |
optional |
Filter results by keyword. |
datefilter |
date [YYYY-MM-DD] |
optional |
Filter results by date. |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: crm. |
sub_section |
string |
Returns a requested CRM sub-section: products. |
products |
array |
CRM product details are listed here. |
products_total |
integer |
Returns of total number of CRM products based on filters. |
page |
integer |
Returns a requested page. |
step |
integer |
Returns a requested step. |
filter |
string |
Returns a requested filter keyword. |
datefilter |
string |
Returns a requested date. Returns empty value or date in YYYY-MM-DD format. |
order |
string |
Returns a requested order field. |
odirection |
string |
Returns a requested order direction. [asc, desc] |
api_version |
integer |
Returns a requested api version. [1, 2] |
Get Product
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/product/{id}
URL Parameters
Parameter |
Type |
Status |
Description |
id |
integer |
required |
Set the product unique id |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: crm. |
sub_section |
string |
Returns a requested CRM sub-section: products. |
section_uid |
integer |
Product ID |
action |
string |
[get] |
data |
array |
Product details are listed here. |
api_version |
integer |
Returns a requested api version. [1, 2] |
CRM Purchase Orders
API section for CRM Purchase Orders.
Listing
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/purchase-orders/
URL Parameters
Parameter |
Type |
Status |
Description |
page |
integer |
optional |
Sets the page. Default: 1 |
step |
integer |
optional |
Defines how many results are listed for the current page. Default: 10, Max Value: 1000 |
order |
string |
optional |
Enum [id, purchase_order_number, created, modified, crm_customer_uid, crm_customer] |
odirection |
string |
optional |
Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc |
filter |
string |
optional |
Filter results by keyword. |
datefilter |
date [YYYY-MM-DD] |
optional |
Filter results by date. |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: crm. |
sub_section |
string |
Returns a requested CRM sub-section: purchase-orders. |
purchase-orders |
array |
CRM purchase order details are listed here. |
purchase-orders_total |
integer |
Returns of total number of CRM purchaseorders based on filters. |
page |
integer |
Returns a requested page. |
step |
integer |
Returns a requested step. |
filter |
string |
Returns a requested filter keyword. |
datefilter |
string |
Returns a requested date. Returns empty value or date in YYYY-MM-DD format. |
order |
string |
Returns a requested order field. |
odirection |
string |
Returns a requested order direction. [asc, desc] |
api_version |
integer |
Returns a requested api version. [1, 2] |
Get Purchase Order
Requires Authentication
HTTP Request
GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/purchase-order/{id}
URL Parameters
Parameter |
Type |
Status |
Description |
id |
integer |
required |
Set the Purchase Order unique id |
JSON Response
Parameter |
Type |
Description |
section |
string |
Returns a requested section: crm. |
sub_section |
string |
Returns a requested CRM sub-section: purchase-orders. |
section_uid |
integer |
Purchase Order ID |
action |
string |
[get] |
data |
array |
Purchase Order details are listed here. |
api_version |
integer |
Returns a requested api version. [1, 2] |
Errors
If an error exists, Flavor Studio’s API returns JSON with error codes and a message. If there is no Basic Auth username or password it will redirect the request to the Flavor Studio login page. In any other error cases it will return JSON data with the following details.
JSON Response
Error Code |
Message |
Description |
invalid_request |
Invalid request. |
You get invalid request code in case that the call is made over plain HTTP. |
invalid_type |
Invalid type. |
Type is not defined in the url or invalid type defined. |
invalid_section |
Invalid section. |
Section is not defined in the url or invalid section name is defined. |
invalid_api_key |
Invalid API key. |
This code represents invalid API keys or that the API is disabled. |
invalid_email |
Email address required.
Invalid email address.
|
This code represents invalid or empty email address. |
invalid_user |
Invalid user. |
This error occurs when the user can't be found in the organization. |
invalid_id |
Project not found!
Recipe not found!
Ingredient not found!
Taste Test not found!
|
This error occurs when the data can't be found within the organization based on the ID and section. |