Getting a list of freespin campaigns

Overview

Request type	URL
GET	<server-pixmove-games>/freespins/list

This method allows you to get an up-to-date list of freespin campaigns.

How it works

The implementation of freespins involves two main entities: a freespin campaign and freespins. Within a single freespin campaign, a user can receive only one set of freespins.

A freespin campaign is a general promotion that a partner can create. Based on its parameters, players will be awarded freespins.

Freespins are complimentary spins that are credited to players when they enter the game.

When a player enters the game, the system checks if they match the campaign’s conditions (e.g., correct currency, game, or specific player identifier). If they qualify, the player receives the freespins.

Parameters

Request

All parameters in this request except partnerId - optional.
If they are passed - they are used to filter received freespin campaigns.

Name	Type		Description
partnerId	bigint		Unique partner identifier
hash	string		Signature (sha256 from encryption string)
campaignExtId	string	optional	Unique identifier of the campaign in the partner's system
currencies	array	optional	Currencies for which freespins were issued
gameIds	array	optional	Game identifiers for which freespins were issued
playerIds	array	optional	Player identifiers for which freespins were issued
status	string	optional	Status of freespin campaign ("active", "completed", "canceled")
closed	boolean	optional	Flag determining whether only closed freespin campaigns will be returned
startTimeFrom	string	optional	Freespin campaign startTime in ISO 8601 format
startTimeTo	string	optional	Freespin campaign startTime in ISO 8601 format
endTimeFrom	string	optional	Freespin campaign endTime in ISO 8601 format
endTimeTo	string	optional	Freespin campaign endTime in ISO 8601 format
limit	bigint	optional	Number of freespin campaigns to return
offset	bigint	optional	Offset, determining from which freespin campaign to start returning
withFreespins	boolean	optional	Flag determining whether information about current freespins for campaigns will be included

String to hash

“freespins_list” + partnerId + apiKey

Response

Name	Type	Description
campaigns	array	Array with freespin campaigns

Example

Request

{  
    partnerId: 1,
    campaignExtId: 1,
    currencies: ['USD', 'EUR'],
    gameIds: [1, 2, 3],
    playerIds: ['1', '2', '3'],
    status: 'active',
    closed: false,
    startTimeFrom: '2025-07-01T15:04:32.384Z',
    startTimeTo: '2025-07-07T15:04:32.384Z',
    endTimeFrom: '2025-07-01T15:04:32.384Z',
    endTimeTo: '2025-07-07T15:04:32.384Z',
    limit: 10,
    offset: 0,
    withFreespins: true,
    hash: '123' 
}

Response

{
    "status": "success",
    "data": {
        "campaigns": [
            {
                "id": 11,
                "extId": "22",
                "spinCount": 20,
                "betLevel": 8,
                "closed": false,
                "maxWin": null,
                "minWin": 0,
                "startTime": "2025-07-01T15:04:32.384Z",
                "endTime": "2025-08-25T15:05:16.592Z",
                "partnerId": 1,
                "Freespins": [
                    {
                        "id": 23,
                        "campaignId": 11,
                        "playerId": 164,
                        "gameId": 17,
                        "currencyId": 1,
                        "status": "active",
                        "currentSpins": 0,
                        "currentWin": 0,
                        "closed": false
                    }
                ]
            }
        ]
    },
    "serverTime": 1752245215266,
    "duration": 182
}