Get Menus

get

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

Returns a list of menus 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 menu name to query on.

uid

string

A UID (unique menu ID) to filter on.

description

string

Query the contents of the description field.

created_by

string

A user ID.

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).

starting_date

date

Filter on a menu start date (exact)

starting_date__gt

date

Filter on a menu start date (greater than)

starting_date__lt

date

Filter on a menu start date (lower than)

ending_date

date

Filter on a menu end date (exact)

ending_date__gt

date

Filter on a menu end date (greater than)

ending_date__lt

date

Filter on a menu end date (lower than)

current_sell_price

float

Filter on a sell price (exact)

current_sell_price__gt

float

Filter on a sell price (greater than)

current_sell_price__lt

float

Filter on a sell price (lower than)

vat

float

Filter on a tax rate.

vat__gt

float

Filter on a tax rate (greater than).

vat__lt

float

Filter on a tax rate (lower than).

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