Games API

Create and list games in Playtest Parlor via the API.

The Games API lets you create new games and retrieve a list of games you own.

List Games

Retrieve all games in your account.

Request:

GET /api/v1/games
Authorization: Bearer pp_your_token

Response:

{
  "games": [
    {
      "id": "game_1a2b3c4d",
      "name": "My Game",
      "createdAt": "2026-04-20T14:30:00Z"
    },
    {
      "id": "game_5e6f7g8h",
      "name": "Another Game",
      "createdAt": "2026-04-19T10:15:00Z"
    }
  ]
}

Response Fields:

FieldTypeDescription
gamesarrayArray of game objects
games[].idstringUnique game identifier
games[].namestringDisplay name of the game
games[].createdAtstringISO 8601 timestamp when the game was created

Create Game

Create a new game ready for components and assets.

Request:

POST /api/v1/games
Authorization: Bearer pp_your_token
Content-Type: application/json

{
  "name": "My Board Game"
}

Request Body:

FieldTypeRequiredDescription
namestringyesDisplay name for the game (max 256 characters)

Every game you create is private: only you, the collaborators you invite, and Playtest Parlor's administrators can open it. Players join a table of it through that table's link. A request that includes visibility is refused with VALIDATION_ERROR.

Response:

{
  "id": "game_1a2b3c4d",
  "name": "My Board Game",
  "createdAt": "2026-04-20T14:30:00Z"
}

Response Fields:

FieldTypeDescription
idstringUnique identifier for the game
namestringThe game name you provided
createdAtstringISO 8601 timestamp of creation

Errors:

  • VALIDATION_ERROR: The game name is missing or too long, or the request sets visibility, which can no longer be set
  • UNAUTHORIZED: Your token is invalid or missing
  • PLAN_LIMIT (402): The account already has as many games as its plan allows (one on Starter, 5 on Casual; Pro has no limit). The message names the plan to upgrade to
  • RATE_LIMITED: You have created games too quickly: 5 at once, then 10 an hour (one every 6 minutes), counting games the person creates on the site or imports from a .pp file. Wait the Retry-After seconds

Typical Workflow

After creating a game, you can:

  1. Upload images as assets using the Assets API
  2. Create game components (tiles, decks, tokens) using the Components API
  3. Reference the game ID in all asset and component operations