Favourites

GET /favourites

Get all favourite sections, in flat or tree view

Request

Base URL
https://api.fergus.com
Auth
- OAuth 2
  Authorization codehttps://auth.fergus.com/oauth2/authorize
  Token URLhttps://auth.fergus.com/oauth2/token
- or HTTP bearer
TypeScript
https://skmtc.dev/fergus/apis/fergus-api/docs/favourites/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pageSizeinteger

'asc'

OR

'desc'

pageCursorstring

filterSectionNamestring

Searchable fields:

representation: tree
- section.name
representation: flat
- section.name

'name'

OR

'createdAt'

OR

'sortOrder'

'flat'

OR

'tree'

filterSearchTextstring

Searchable fields:

representation: tree
- section.name
- lineItem.itemName,
representation: flat
- section.name
- section.description,
- lineItem.itemName

Response

Successful Response

resultstring required

Changes

No recorded changes to this operation across all 18 revisions of this API.