List favorites by price list

get

https://rls.congacloud.com/api/favorite/v1/favorites

Retrieves a list of active favorites associated with the provided Price List ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter

array of strings

Add conditional filters in standard URI format to narrow down the search result. For example, "in(Scope:'Public','Private')".

filter

query

string

Enter the name of the FavoriteConfiguration to narrow down the search result. The API can only match a maximum of 20 characters. If the input string is longer than 20 characters, the API retrieves FavoriteConfigurations where the name matches the first 20 characters of the search string.

sort

string

Enter the fields and sort order for the result. Add multiple fields to sort the result further. By default, sort order is ascending based on relevance.

page

int32

Defaults to 1

Enter the page number of the search result from where to view the result.

limit

int32

Defaults to 50

Enter the number of records to display on each page. By default, the API displays 50 records on each page. A maximum of 500 records are displayed on each page.

Headers

pricelistid

string

Enter the price list ID to retrieve the Favorites associated with it. The API displays a validation error in case an inactive price list ID is entered.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200OK

400Bad Request