Skip to main content

GET Player by Pagination


The following table contains important information about the GET method in regards to receiving the players by pagination.

GET Player by Pagination
URL or Endpoint/api/projects/projectId/players
ParametersprojectId, search, page, take, order, insertedDate
BodyNot Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
DescriptionUnique Id of the project

The description of the parameters is as follows:

Parameter NameMandatoryTypeDescription
searchYesstringA word you want to filter.
pageYesinteger($int32)The page in which the player is located
takeYesinteger($int32)The number of players to take from the page
orderYesstringThe order in which you receive the players.
insertedDateNoDateThe date

Request Body

The request does not contain a request body


"success": true,
"errors": [],
"messages": [],
"result": {
"currentPage": 1,
"totalPages": 6,
"pageSize": 2,
"totalCount": 11,
"items": [
"publicId": "ptkzupxd",
"name": "Player i njomexesd -u",
"size": "16:9",
"cloudHostedPlayerLibrary": "",
"version": "v1.5"
"publicId": "ptkzupxi",
"name": "Player with updated config renamed",
"size": "16:9",
"cloudHostedPlayerLibrary": "",
"version": "v1.5"
"resultInfo": null,
"statusCode": 200

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
currentPageinteger($int32)Indicates the current page of where the player is located.
totalPagesinteger($int32)The total number of pages.
pageSizeinteger($int32)Indicates how many players are per page.
totalCountinteger($int32)The total number of players received by the filter.
itemsarray[Object]Returns the players on the current page as an array of objects.
publicIdstringThe public ID of the player.
namestringThe name of the player.
sizestringThe screen ratio of the player.
cloudHostedPlayerLibrarystringThe URL of the cloud hosted player library.
versionstringThe version of the player.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.


For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed