Content Portal API

GET content

Get paged content information. Options exist to control paging behavior, sort the results, and filter by:

Item category (game, asset, etc.)
Item status (admins only)

Examples

No Arguments
Filter and Sort

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

{
  "items": [{
    "id": "393af00f-b965-441f-9bf2-cf141212c27d",
    "listingId": 286,
    "revisionId": "a04bd9a7-cdf2-4398-a6ff-445d4fa5c810",
    "authorUsername": "tcoles+test01",
    "authorAvatar": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/ec9fbd31-d78a-44ac-8566-3500cd1953bc.jpg",
    "authorEmblem": "064a4b8d-4b42-4d9b-b5e6-da6dadd2026e",
    "type": "game",
    "status": "active",
    "name": "Chandler 153",
    "thumbnailUri": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/e0eecb57-7527-4b0c-8de3-6dab8d04f419.jpg",
    "featured": false,
    "rating": "1"
  },
  {
    "id": "1d9ca639-1bc7-4c1c-b980-dc2d581334c3",
    "listingId": 297,
    "revisionId": "e2a4adf3-da49-423b-8b72-5b3d5f21bb88",
    "authorUsername": "tcoles+test01",
    "authorAvatar": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/ec9fbd31-d78a-44ac-8566-3500cd1953bc.jpg",
    "authorEmblem": "064a4b8d-4b42-4d9b-b5e6-da6dadd2026e",
    "type": "game",
    "status": "active",
    "name": "Phoenix 581",
    "thumbnailUri": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/b31ac216-4c5b-4413-b3d0-e8a8dee96ed7.jpg",
    "featured": true,
    "rating": "0.5"
  }],
  "page": 0,
  "pageSize": 48,
  "total": 2
}

Security

Authentication is not generally required for this method, but certain content items are restricted to certain users based on their status. Suspended and Deleted content is restricted to admins only.

Query Parameters

Name	Description	Value
category	filter on the type of content; by default, show all types optional	one of: `game` `asset` `box`
status	filter on the status of content; only admins will see the effect of this option; by default, show active items only optional	one of: `all` `suspended`
sort	the sort method to apply to results; by default, sort by creation date descending optional	one of: `created-asc` `created-desc` `rating-asc` `rating-desc` `name-asc` `name-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. Items are of type ContentInfo.

ContentInfo

Name	Description	Value
id	the ID of the content item as a GUID with dashes	string
listingId	the ID of the most recent listing	number
revisionId	the ID of the most recent revision	string
authorUsername	the username of the author of this content	string
authorAvatar	a file path to the author's avatar, relative to the media content bucket	string
authorEmblem	the author's selected emblem ID, as a GUID with dashes	string or null
type	the type of this content item	one of: `game` `avatar_box` `gameplay_box` `scene_box` `asset`
status	the status of this content item	one of: `active` `suspended` `deleted_user` `deleted_admin`
name	the name of this content item	string
thumbnailUri	the path to this item's primary screenshot, relative to the media content bucket	string
featured	whether or not this content item has been featured	boolean
rating	the aggregate rating score of this content item based on user votes, as a number between 0 and 1	number