getBoardgames(_:)

func getBoardgames(_ req: Request) async throws -> BoardgameResponseData

GET /api/v3/boardgames

Returns an array of boardgames in a structure designed to support pagination. Can be called while not logged in; if logged in favorite information is returned.

URL Query Parameters

  • ?search=STRING - Only show boardgames whose title contains the given string.
  • ?favorite=TRUE - Only return boardgames that have been favorited by current user.
  • ?start=INT - Offset from start of results set

  • ?limit=INT - the maximum number of games to retrieve: 1-200, default is 50.

Return Value

BoardgameResponseData

Show on GitHub