Get products

GET
/products

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Query parameters

orderenumOptional

Sort order (ascending by default). Typically used together with the sort parameter.

Allowed values: ascdesc
limitintegerOptional>=1<=100Defaults to 100

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

pagination_tokenstringOptional

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

sort"name"OptionalDefaults to name

The field to sort the results by. Typically used together with the order parameter.

id__instringOptionalformat: "uuid"
namestringOptional
name__containsstringOptional
name__icontainsstringOptional
typeenumOptional
Allowed values: productservice
priceintegerOptional
price__gtintegerOptional
price__ltintegerOptional
price__gteintegerOptional
price__lteintegerOptional
currencyenumOptional
currency__inenumOptional
measure_unit_idstringOptional
created_at__gtdatetimeOptional
created_at__ltdatetimeOptional
created_at__gtedatetimeOptional
created_at__ltedatetimeOptional

Response

Successful Response

datalist of objects
next_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you’ve reached the last page).

prev_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you’ve reached the first page).

Errors