Use a list of uuids or tags to create a set of players

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json
RESPONSE
201 (Created)
[
  "players": [
    {
      "id": 1111,
      "uuid": "eQSsPVXinqGoesujP2Vteg",
      "name": "My Player",
      ...
    },
      "id": 1156,
      "uuid": "YBQpV0CPF5ht1UGj0qPHQQ",
      "name": "My Player",
      ...
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 2,
    "count": 4
  }
]

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

uuids
optional , nil allowed

A list of uuids to select players from

Validations:

  • Must be an array of any type

tag_attributes
optional , nil allowed

A list of tags that can be used to select players which have been assigned the given tag

Validations:

  • Must be an array of any type

per_page
optional

The number of items to show per page
Maximum: 200, Default: 20

Validations:

  • Parameter has to be Integer.

page
optional

The page number to include in the response
Default: 1

Validations:

  • Parameter has to be Integer.

order_by
optional

The attribute to order the list by
Value: Must be one of: name, created_at, updated_at

Validations:

  • Must be one of: name, created_at, updated_at.

direction
optional

Only applies when order_by used
Default: asc
Value: Must be one of: asc, desc

Validations:

  • Must be one of: asc, desc.

custom_order
optional

Array of player UUIDs that specifies the ordering of the returned set.
Using this parameter will override the order_by/direction params

Validations:

  • Must be an array of any type

query
optional

Only return players which match the given query by player name, video name or tag

Validations:

  • Must be a String