---
title: "GET /favourites"
method: GET
path: "/favourites"
tags: ["Favourites"]
---

# GET /favourites

`GET /favourites`

Get all favourite sections, in flat or tree view

## Query parameters

- `pageSize` integer
- `sortOrder` union
  - 'asc'
  - 'desc'
- `pageCursor` string
- `filterSectionName` string
- `sortField` union
  - 'name'
  - 'createdAt'
  - 'sortOrder'
- `representation` union
  - 'flat'
  - 'tree'
- `filterSearchText` string

## Response `200`

Successful Response

- FavouritesResponse
  - `result` string, required
  - `data` FavouritesResponseData[], required
    - union
      - object
        - `id` number, required
        - `name` string, required
        - `parentId` number, nullable, required
        - `createdAt` string, required
        - `children` FavouritesFolder[], nullable, required
          - `id` number, required
          - `name` string, required
          - `parentId` number, nullable, required
          - `createdAt` string, required
          - `children` FavouritesFolder[], nullable, required
          - `sortOrder` number, required
          - `sections` object[], nullable, required
            - `id` number, required
            - `name` string, required
            - `description` string, nullable, required
            - `createdAt` string, required
            - `links` Links, required
              - …
        - `sortOrder` number, required
        - `sections` object[], nullable, required
          - `id` number, required
          - `name` string, required
          - `description` string, nullable, required
          - `createdAt` string, required
          - `links` Links, required
            - `href` string, required
            - `rel` string, required
            - `type` 'GET' | 'POST' | 'PUT' | 'PATCH', required
      - object
        - `id` number, required
        - `name` string, required
        - `description` string, nullable, required
        - `folderId` number, required
        - `createdAt` string, required
        - `fixturePrice` number, nullable, required
        - `totalItemCost` number, required
        - `totalItemPrice` number, required
        - `path` object[], required
          - `id` number, required
          - `name` string, required
          - `position` number, required
          - `href` string, nullable, required
  - `paging` Pagination
    - `perPage` number, required
    - `pageCount` number, required
    - `links` object, required
      - `self` string, required
      - `previous` string, nullable, required
      - `next` string, nullable, required

## Other responses

- `4XX` — Client Request Errors
- `5XX` — Server Errors

---

[API](https://skmtc.dev/fergus/apis/fergus-api.md) · [All operations](https://skmtc.dev/fergus/apis/fergus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fergus/fergus-api/revisions/b4f232a22363/schema)