List playsets

GET

/api/v1/playsets

Soft-deleted playsets are never listed. Filterable on id, name, variants, scenario, gameId, gameName, ownerId, ownerName, expansionsId, expansionsName, createdAt, updatedAt; sortable on id, name, scenario, createdAt, updatedAt.

Authorizations

• bearerAuth
  stx-engine:playset-read

Parameters

Query Parameters

limit

integer

>= 1 <= 100

Maximum number of items to return

cursor

string

Opaque cursor from a previous response’s nextCursor. Omit to fetch the first page. Clients must treat this value as opaque and only pass back what was previously returned.

filter

string

RSQL filter expression evaluated against this resource’s filterable fields. Combine multiple conditions with ; (AND) or , (OR), e.g. gameId==3fa85f64-...;playedAt=gt=2026-01-01T00:00:00Z. The set of filterable fields is documented per endpoint in the API reference; filtering on a field that isn’t in that whitelist returns 400 Bad Request.

sort

string

/^([a-zA-Z0-9_]+(:(ASC|DESC))?)(,([a-zA-Z0-9_]+(:(ASC|DESC))?))*$/

Sort order. Format: field:direction. Direction is ASC or DESC (default ASC if omitted). Use a comma-separated list for multi-column sorting; priority follows the parameter order.

Examples

Sort by a single column

playedAt:DESC

Sort by multiple columns

playedAt:DESC,status:ASC

Omitted direction defaults to ASC

status,playedAt:DESC

Responses

200

Playsets retrieved successfully

object

limit

required

Maximum number of items returned in this page

integer format: int32

prevCursor

Opaque cursor to pass as the cursor query parameter to fetch the previous page. Null when there is no previous results. Clients must not parse or construct this value.

string | null

nextCursor

Opaque cursor to pass as the cursor query parameter to fetch the next page. Null when there are no more results. Clients must not parse or construct this value.

string | null

items

required

Playsets in this page

Array<object>

object

id

required

string format: uuid

owner

required

object

id

required

string format: uuid

displayName

required

string

game

required

object

id

required

string format: uuid

displayName

required

string

displayName

string

>= 1 characters <= 100 characters

variants

required

Rule variants that are played

Array<string>

<= 20 items unique items

scenario

string

>= 1 characters <= 200 characters

expansions

required

Array<object>

object

id

required

string format: uuid

displayName

required

string

createdAt

required

Date-time (ISO 8601)

string format: date-time

updatedAt

Date-time (ISO 8601)

string format: date-time

deletedAt

Date-time (ISO 8601)

string format: date-time

400

Request validation failed

object

type

required

Canonical error type identifier (URI). The values are the problem types of stratastax-http’s problem-core; stratastax-codegen fails the build of a service when the two disagree.

string

Allowed values: https://errors.stratastax.dev/authentication https://errors.stratastax.dev/authorization https://errors.stratastax.dev/validation https://errors.stratastax.dev/not-found https://errors.stratastax.dev/conflict https://errors.stratastax.dev/precondition-failed https://errors.stratastax.dev/internal

title

required

Short, human-readable summary

string

status

required

HTTP status code

integer format: int32

detail

required

Human-readable explanation

string

instance

URI of the request that caused the error

string format: uri

errors

Array<object>

object

field

required

Field or property that failed validation

string

code

required

Machine-readable validation error code, e.g. REQUIRED, VALUE_TOO_LONG, INVALID_FORMAT, OUT_OF_RANGE. Canonical list is maintained per resource in the documentation.

string

message

required

Human readable validation message

string

rejectedValue

The actual value that failed validation. Omitted if the value is sensitive.

Examples

{
  "type": "https://errors.stratastax.dev/validation",
  "title": "Bad Request",
  "status": 400,
  "detail": "Received invalid request data",
  "errors": [
    {
      "field": "displayName",
      "code": "REQUIRED",
      "message": "missing required field"
    }
  ]
}

{
  "type": "https://errors.stratastax.dev/validation",
  "title": "Bad Request",
  "status": 400,
  "detail": "Received invalid request data",
  "errors": [
    {
      "field": "participants[2].ghostPlayerId",
      "code": "DUPLICATE_GHOST_PLAYER",
      "message": "the ghost player already takes part in this match"
    }
  ]
}

{
  "type": "https://errors.stratastax.dev/validation",
  "title": "Bad Request",
  "status": 400,
  "detail": "Request validation failed",
  "errors": [
    {
      "field": "query",
      "code": "INVALID_SEARCH",
      "message": "'nonsense' is not a filterable field"
    }
  ]
}

401

Authentication required or token invalid

object

type

required

Canonical error type identifier (URI). The values are the problem types of stratastax-http’s problem-core; stratastax-codegen fails the build of a service when the two disagree.

string

Allowed values: https://errors.stratastax.dev/authentication https://errors.stratastax.dev/authorization https://errors.stratastax.dev/validation https://errors.stratastax.dev/not-found https://errors.stratastax.dev/conflict https://errors.stratastax.dev/precondition-failed https://errors.stratastax.dev/internal

title

required

Short, human-readable summary

string

status

required

HTTP status code

integer format: int32

detail

required

Human-readable explanation

string

instance

URI of the request that caused the error

string format: uri

Examples

{
  "type": "https://errors.stratastax.dev/authentication",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication required"
}

403

Insufficient permissions

object

type

required

Canonical error type identifier (URI). The values are the problem types of stratastax-http’s problem-core; stratastax-codegen fails the build of a service when the two disagree.

string

Allowed values: https://errors.stratastax.dev/authentication https://errors.stratastax.dev/authorization https://errors.stratastax.dev/validation https://errors.stratastax.dev/not-found https://errors.stratastax.dev/conflict https://errors.stratastax.dev/precondition-failed https://errors.stratastax.dev/internal

title

required

Short, human-readable summary

string

status

required

HTTP status code

integer format: int32

detail

required

Human-readable explanation

string

instance

URI of the request that caused the error

string format: uri

Examples

{
  "type": "https://errors.stratastax.dev/authorization",
  "title": "Access denied",
  "status": 403,
  "detail": "Insufficient permissions"
}

500

Unexpected server error

object

type

required

Canonical error type identifier (URI). The values are the problem types of stratastax-http’s problem-core; stratastax-codegen fails the build of a service when the two disagree.

string

Allowed values: https://errors.stratastax.dev/authentication https://errors.stratastax.dev/authorization https://errors.stratastax.dev/validation https://errors.stratastax.dev/not-found https://errors.stratastax.dev/conflict https://errors.stratastax.dev/precondition-failed https://errors.stratastax.dev/internal

title

required

Short, human-readable summary

string

status

required

HTTP status code

integer format: int32

detail

required

Human-readable explanation

string

instance

URI of the request that caused the error

string format: uri

Examples

{
  "type": "https://errors.stratastax.dev/internal",
  "title": "Oops! Something went wrong.",
  "status": 500,
  "detail": "Try again later."
}