Skip to main content
GET
List the caller's own sideboard guides

Authorizations

X-Signature
string
header
required

HMAC-SHA256 over canonical request string. Format: v1.<unix_seconds>.<hex_hmac_sha256>.

X-Partner-Id
string
header
required

Partner identifier slug. Required alongside X-Signature for HMAC auth.

Authorization
string
header
required

User-issued personal access token (format: flx_pat_).

Path Parameters

game
string
required

Query Parameters

archetypeId
string

Case-insensitive substring filter on related matchup opponent_archetype.

createdAfter
string<date-time>

ISO 8601 lower bound on creation timestamp (inclusive).

createdBefore
string<date-time>

ISO 8601 upper bound on creation timestamp (inclusive).

deckId
string<uuid>

Filter to guides whose m2m membership includes this deck.

editedAfter
string<date-time>

ISO 8601 lower bound on last-edit timestamp (inclusive).

editedBefore
string<date-time>

ISO 8601 upper bound on last-edit timestamp (inclusive).

format
string

Case-insensitive substring filter on the guide's plain format string. Guides have no format FK, so this is a string filter named format — a deliberate divergence from the deck list's formatId.

hasVideo
boolean

Filter to guides that do/don't link a YouTube video.

include
enum<string>

Set to summary to add featured_cards, colors and matchup_count to each list item — enough to render a rich guide card without a per-guide detail fetch. Omitted by default to keep the list lean.

Available options:
summary
limit
integer

Page size (max 100, default 20).

order
enum<string>

Sort direction. Defaults to desc.

Available options:
asc,
desc
page
integer

1-indexed page number.

q
string

Substring filter on guide name (case-insensitive).

sort
enum<string>

Sort key. Defaults to editedAt.

Available options:
createdAt,
editedAt,
likes,
views

Response

200 - application/json

Provides featured_cards for any deck serializer.

Relies on special_cards__card (and legacy commander/partner/companion FKs) being prefetched/selected by the caller's selector. The GameSpecialCardType lookup is cached on serializer context so a whole page of decks costs one query, not one per deck.

id
string<uuid>
required
read-only
name
string
required
read-only
author
object | null
required
read-only
game
string
required
read-only
visibility
string[]
required
read-only
deck_id
string<uuid>
required
read-only
format
string
required
read-only
views
integer
required
read-only
likes
integer
required
read-only
hasMatchups
boolean
required
read-only
thumbnail
string | null
required
read-only
editedAt
string<date-time>
required
read-only
createdAt
string<date-time>
required
read-only
sourceProvider
string | null
required
read-only
colors
string[]
read-only
matchup_count
integer
read-only