Get a list of players. Note that if ‘per_page’ or ‘page’ are used this end point returns a different format. It is recommended to always use ‘per_page’.

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

// USING PER_PAGE OR PAGE
REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "players": [
    {
      "id": 1111,
      "uuid": "eQSsPVXinqGoesujP2Vteg",
      "name": "My Player",
      ...
    },
      "id": 1156,
      "uuid": "YBQpV0CPF5ht1UGj0qPHQQ",
      "name": "My Player",
      ...
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 2,
    "count": 4
  }
}

// NOT USING PER_PAGE OR PAGE
REQUEST
Accept: application/json

RESPONSE
200 (OK)
[
  {
    "id": 1111,
    "uuid": "eQSsPVXinqGoesujP2Vteg",
    "name": "My Player",
    ...
  },
    "id": 1156,
    "uuid": "YBQpV0CPF5ht1UGj0qPHQQ",
    "name": "My Player",
    ...
  }
]

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

per_page
optional

The number of items to show per page
Maximum: 200

Validations:

  • Parameter has to be Integer.

page
optional

The page number to include in the response
Only applies when per_page used
Default: 1

Validations:

  • Parameter has to be Integer.

order_by
optional

Only works if ‘per_page’ or ‘page’ parameters are also set.
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 works if ‘per_page’ or ‘page’ parameters are also set.
When the direction to order the list
Only applies when order_by used
Default: asc
Value: Must be one of: asc, desc

Validations:

  • Must be one of: asc, desc.

query
optional

Only works if ‘per_page’ or ‘page’ parameters are also set.
A string used to search for a set a players by player / video name as well as all associated tags

Validations:

  • Must be a String

include_subgroups
optional

Only works if ‘per_page’ or ‘page’ parameters are also set.
Include players from sub-groups
Default: false

Validations:

  • Must be one of: true, false, 1, 0.