Content Portal API

GET games

Retrieve a paged listing of currently active multiplayer games.

Example

GET /api/v1/games HTTP/1.1
Accept: application/json
----------------------------------------
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "items": [{
    "id": "a2c4f9bd-b698-4b21-839d-81e75e514d0c",
    "instanceId": "a2c4f9bd-b698-4b21-839d-81e75e514d0c",
    "playId": "TerminalScene01",
    "name": "Terminal",
    "maxPlayers": 16,
    "currentPlayers": 4,
    "created": 1537907432
  },{
    "id": "1e544c18-f56f-491b-a1b1-a0b02528fb10",
    "instanceId": "1e544c18-f56f-491b-a1b1-a0b02528fb10",
    "playId": "bfba9f87-c805-4f13-8e60-77d2473e4867",
    "name": "Death Race 2000",
    "maxPlayers": 8,
    "currentPlayers": 1,
    "created": 1537933208
  }],
  "page": 0,
  "pageSize": 48,
  "total": 2
}

Security

Authentication is not required for this method.

URL Parameters

NONE

Query Parameters

Name	Description	Value
playId	filter results with this playId, by exact match optional	string
full	filter results based on capacity; `false` is the only supported value, which will return only servers which are not currently full optional	one of: `false`
sort	the sort method to apply to results optional	one of: `name-asc` `name-desc` `created-asc` `created-desc` `max-players-asc` `max-players-desc` `current-players-asc` `current-players-desc` `open-seats-asc` `open-seats-desc`
page	the 0-indexed page to return; by default, page 0 optional	number
size	the number of items to return per page; may not be less than 10 or greater than 200; by default, 48 optional	number

Request Body

NONE

Response

Successful responses are code 200 with data in the response body. Error responses are standard.

Response Body

The response body is wrapped in a Paged data structure (described at this link). Items are of type Game (described below).

Game

Name	Description	Value
id	the ID of the game instance, as a UUID with dashesNOTE: this field is deprecated and will be removed. Use `instanceId` instead.	string
instanceId	the ID of the game instance, as a UUID with dashes	string
playId	the ID of the game being played on this instance; it may be a UUID of an entity (by reivision), or it may be another identifier known by the game client.	string
name	the name given to the game	string
maxPlayers	the maximum number of players allowed to join the game	number
currentPlayers	the number of players current connected to the game	number
created	the time the game was created, as a Unix timestamp	number