games.atplay.listInvitations

atplay.games

Documentation

List the games a player is part of — ones they started and ones they were invited to — newest first.

main query

List the games a player is part of — ones they started and ones they were invited to — newest first.

Parameters

cursor string Optional

Pagination cursor.

limit integer Optional

Maximum number of games to return.

player string did Optional

Whose games to list. Defaults to the authenticated caller.

Output

Encodingapplication/json
cursor string Optional

Cursor for the next page, absent if no more results.

games array Required

No description available.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Pagination cursor.
Maximum number of games to return.
Whose games to list. Defaults to the authenticated caller.
View raw schema 
{
  "description": "List the games a player is part of — ones they started and ones they were invited to — newest first.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "description": "Cursor for the next page, absent if no more results.",
          "maxLength": 512,
          "type": "string"
        },
        "games": {
          "items": {
            "ref": "#gameSummary",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "games"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "cursor": {
        "description": "Pagination cursor.",
        "maxLength": 512,
        "type": "string"
      },
      "limit": {
        "default": 50,
        "description": "Maximum number of games to return.",
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      },
      "player": {
        "description": "Whose games to list. Defaults to the authenticated caller.",
        "format": "did",
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}
gameSummary object

One game a player is part of, with just enough to list and rejoin it.

Properties

initiator string did Optional

Who sent the invitation.

invitation string at-uri Required

The invitation that started this game.

maxLength: 512 bytes
latestTurn string at-uri Optional

The most recent turn, absent while the game is still pending.

maxLength: 512 bytes
pending boolean Required

True while nobody has taken a turn. Acceptance is the invitee's first turn, so an unanswered invitation stays pending (ADR 0031).

players array of stringdid Optional

The players invited, not counting the initiator.

turnCount integer Required

How many turns have been published against this invitation.

minimum: 0
yourMove boolean Required

True when the latest turn names this player as one of the next to act.

View raw schema 
{
  "description": "One game a player is part of, with just enough to list and rejoin it.",
  "properties": {
    "game": {
      "description": "The release the invitation named.",
      "ref": "games.atplay.game.release",
      "type": "ref"
    },
    "initiator": {
      "description": "Who sent the invitation.",
      "format": "did",
      "type": "string"
    },
    "invitation": {
      "description": "The invitation that started this game.",
      "format": "at-uri",
      "maxLength": 512,
      "type": "string"
    },
    "latestTurn": {
      "description": "The most recent turn, absent while the game is still pending.",
      "format": "at-uri",
      "maxLength": 512,
      "type": "string"
    },
    "pending": {
      "description": "True while nobody has taken a turn. Acceptance is the invitee's first turn, so an unanswered invitation stays pending (ADR 0031).",
      "type": "boolean"
    },
    "players": {
      "description": "The players invited, not counting the initiator.",
      "items": {
        "format": "did",
        "type": "string"
      },
      "type": "array"
    },
    "turnCount": {
      "description": "How many turns have been published against this invitation.",
      "minimum": 0,
      "type": "integer"
    },
    "yourMove": {
      "description": "True when the latest turn names this player as one of the next to act.",
      "type": "boolean"
    }
  },
  "required": [
    "invitation",
    "turnCount",
    "pending",
    "yourMove"
  ],
  "type": "object"
}

Lexicon Garden

@