Get Ingredients

get

https://api.apicbase.com/api/v2/products/ingredients/

Returns a list of ingredients in the library.

Query Params

page

int32

A page number within the paginated result set.

ordering

string

A field to order results by.

name

string

A name to query on. Queries names in the Library's native language.

short_name

string

A short name to query on. Queries short names in the library's native language.

composition

string

Query the contents of the composition field.

category

string

Query the contents of the category field.

subcategory

string

Query the contents of the subcategory field.

created_by

string

A user ID.

internal_uid

string

An internal UID (reference number) to query on.

external_uid

string

An external UID (external ID) to query on.

allergen_verified

boolean

Query ingredients whose allergens have been/not been verified.

supplier

string

Query ingredients that have stock items with a given supplier. Takes a supplier ID.

supplier_email

string

Query ingredients that have stock items with a given supplier. Takes an email address..

created_date

date

Filter on a creation date (exact).

created_date__gt

date

Filter on a creation date greater than.

created_date__lt

date

Filter on a creation date lower than.

modified_date

date

Filter on a modification date (exact).

modified_date__gt

date

Filter on a modification date greater than.

modified_date__lt

date

Filter on a modification date lower than.

archived_on

date

Filter on an archival date (exact).

archived_on__gt

date

Filter on an archival date greater than.

archived_on__lt

date

Filter on an archival date lower than.

conversion_ratio

float

Filter on the mass/volume conversion ratio (exact)

conversion_ratio__gt

float

Filter on a mass/volume conversion ratio greater than.

conversion_ratio__lt

string

Filter on a mass/volume conversion ratio lower than.

shelf_life

string

Query the contents of the shelf life field.

approved

boolean

Query ingredients that are approved/not approved.

in_use

boolean

Query ingredients that are/are not in use.

custom_fields

json

Filter on custom fields. Check reference guide for details.

Response

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200