Partner API

Partner API is designed to provide playable game links.

You can retrieve:

game-level links by listing available games,
player-specific links by registering a partner user for a given game.

Use the discovery endpoints (/company, /establishments, /games) to find the right gameId, then call the registration endpoint to generate a unique link for the user.

Getting Started

All requests require a Bearer access token.

Base API endpoint

https://gaming-partner-api.gaming.suggpro.com

Request an API access token

First, navigate to the admin panel in "Settings" > "API Access" and click on "Create an API access token". Complete the form and submit it. In the token list, retrieve your access token.

Once you have your access token, you can use it to call the API using Bearer authentication.

Register player

To register a player for a specific game.

Path to register a player

POST

/player/register/:gameId/:partnerUserId

Parameters to register a player

Headers

Field	Type	Required	Description
`Authorization`	string	Required	The Bearer access token (`Bearer :accessToken`)

Authorization

Bearer ab2d160d-0056-4eba-b271-3f02d50c6ae8

Path parameters

Parameter	Type	Required	Description
`gameId`	string	Required	The game identifier
`partnerUserId`	string	Required	The partner user identifier

POST

/player/register/e90b16e6-e1c2-410d-ba79-706d4e3159ce/11111111

JSON Body parameters

Field	Type	Description
`givenName`	string	The user’s given name
`familyName`	string	The user’s family name
`email`	string	The user email
`phoneNumber`	string	The user phone number (in E.164 format)
`postalCode`	string	The postal code
`country`	string	The country code (in ISO 3166-1 alpha-2 format)

{
  "givenName": "foo",
  "familyName": "bar",
  "email": "foo.bar@suggpro.com",
  "phoneNumber": "+33123456789"
}

json

JSON Response body

Field	Type	Required	Description
`link`	string	Required	The user game link
`playerId`	string	Required	The internal player identifier

{
  "link": "https://test.gaming.suggpro.com/e90b16e6-e1c2-410d-ba79-706d4e3159ce/0e0d2a3a-0b9e-44f9-8b4c-b093c1fe03e4",
  "playerId": "0e0d2a3a-0b9e-44f9-8b4c-b093c1fe03e4"
}

json

HTTP response status codes

Status code	Description
`200`	The request was successful

Get company information

Retrieve company information.

Path to get company information

GET

/company

Parameters to get company information

Headers

Field	Type	Required	Description
`Authorization`	string	Required	The Bearer access token (`Bearer :accessToken`)

Authorization

Bearer ab2d160d-0056-4eba-b271-3f02d50c6ae8

JSON Response body

Field	Type	Required	Description
`companyId`	string	Required	The company identifier
`name`	string	Required	The company name
`createdAt`	string	Required	The creation date (in ISO 8601 format)
`updatedAt`	string		The last update date (in ISO 8601 format)

{
    "companyId": "ffba6ab5-37b5-4a57-8348-bd083a2e1c90",
    "name": "Test",
    "createdAt": "2024-09-23T12:56:04Z",
    "updatedAt": "2025-12-10T16:32:04Z"
}

json

HTTP response status codes

Status code	Description
`200`	The request was successful

List games

To grab the games' information.

The API key is scoped by company

As the API key is scoped by company, you will receive games from any establishment linked to your company.

Path to list games

GET

/games

Parameters to list games

Headers

Field	Type	Required	Description
`Authorization`	string	Required	The Bearer access token (`Bearer :accessToken`)

Authorization

Bearer ab2d160d-0056-4eba-b271-3f02d50c6ae8

JSON Response body

Type: Array<Game>

Game fields (for each array item):

Field	Type	Required	Description
`gameId`	string	Required	The game identifier
`language`	string	Required	The language code (in ISO 639-1 format)
`additionalLanguages`	Array<string>		The additional languages code (in ISO 639-1 format)
`name`	string	Required	The game name
`nameTranslated`	Map<string, string>		The game name in additional languages
`description`	string		The game description
`link`	string	Required	The game link
`establishmentId`	string	Required	The establishment identifier
`status`	string	Required	The game status (`ACTIVE` or `INACTIVE`)
`gameType`	string	Required	The game type (`WHEEL`, `CARDS` or `SCRATCH_CARD`)
`createdAt`	string	Required	The creation date (in ISO 8601 format)
`updatedAt`	string		The last update date (in ISO 8601 format)

[
    {
        "gameId": "e90b16e6-e1c2-410d-ba79-706d4e3159ce",
        "status": "ACTIVE",
        "gameType": "CARDS",
        "establishmentId": "a2673bdc-3d24-4890-816c-2f5c02de156e",
        "language": "fr",
        "name": "Cartes !!",
        "description": "",
        "link": "https://gg.suggpro.com/wnmR",
        "createdAt": "2025-03-18T11:01:12Z",
        "updatedAt": "2025-03-18T11:02:30Z"
    },
    {
        "gameId": "adcca7e4-5941-470b-b391-d91c5298fa36",
        "status": "ACTIVE",
        "gameType": "SCRATCH_CARD",
        "establishmentId": "a2673bdc-3d24-4890-816c-2f5c02de156e",
        "language": "fr",
        "name": "Gratte Gratte !",
        "description": "",
        "link": "https://gg.suggpro.com/F7Gq",
        "createdAt": "2025-03-31T14:55:11Z",
        "updatedAt": "2025-05-06T10:16:58Z"
    },
    {
        "gameId": "4140521d-b6cd-4340-b6d6-334104cd5242",
        "status": "ACTIVE",
        "gameType": "WHEEL",
        "establishmentId": "a2673bdc-3d24-4890-816c-2f5c02de156e",
        "language": "fr",
        "additionalLanguages": [
            "en",
            "de"
        ],
        "name": "Info",
        "nameTranslated": {
            "de": "Info",
            "en": "Info"
        },
        "description": "Jeux multilangue",
        "link": "https://gg.suggpro.com/W12V",
        "createdAt": "2024-11-06T15:31:39Z",
        "updatedAt": "2025-12-12T14:38:38Z"
    }
]

json

HTTP response status codes

Status code	Description
`200`	The request was successful

List establishments

Retrieve establishments list.

Path to list establishments

GET

/establishments

Parameters to list establishments

Headers

Field	Type	Required	Description
`Authorization`	string	Required	The Bearer access token (`Bearer :accessToken`)

Authorization

Bearer ab2d160d-0056-4eba-b271-3f02d50c6ae8

JSON Response body

Type: Array<Establishment>

Establishment fields (for each array item):

Field	Type	Required	Description
`establishmentId`	string	Required	The establishment identifier
`name`	string	Required	The establishment name
`logoUrl`	string		The logo URL
`createdAt`	string	Required	The creation date (in ISO 8601 format)
`updatedAt`	string		The last update date (in ISO 8601 format)

[
    {
        "establishmentId": "a2673bdc-3d24-4890-816c-2f5c02de156e",
        "name": "Test",
        "logoUrl": "https://onvaauresto.gumlet.io/assets/game/establishment-7994ab8d-1bdd-4bde-b643-68fff230ea6e-1739270510895823711/4be7ad51-532c-4c81-8455-89479f37cd0b-0.png",
        "createdAt": "2024-09-23T12:56:12Z",
        "updatedAt": "2025-06-30T14:34:07Z"
    }
]

json

HTTP response status codes

Status code	Description
`200`	The request was successful

Get establishment information

To grab the establishment information.

Path to get establishment information

GET

/establishment/:establishmentId

Parameters to get establishment information

Headers

Field	Type	Required	Description
`Authorization`	string	Required	The Bearer access token (`Bearer :accessToken`)

Authorization

Bearer ab2d160d-0056-4eba-b271-3f02d50c6ae8

Path parameters

Parameter	Type	Required	Description
`establishmentId`	string	Required	The establishment identifier

GET

/establishment/adcca7e4-5941-470b-b391-d91c5298fa36

JSON Response body

Type: Establishment

Establishment fields:

Field	Type	Required	Description
`establishmentId`	string	Required	The establishment identifier
`name`	string	Required	The establishment name
`logoUrl`	string		The logo URL
`createdAt`	string	Required	The creation date (in ISO 8601 format)
`updatedAt`	string		The last update date (in ISO 8601 format)

{
    "establishmentId": "a2673bdc-3d24-4890-816c-2f5c02de156e",
    "name": "Test",
    "logoUrl": "https://onvaauresto.gumlet.io/assets/game/establishment-7994ab8d-1bdd-4bde-b643-68fff230ea6e-1739270510895823711/4be7ad51-532c-4c81-8455-89479f37cd0b-0.png",
    "createdAt": "2024-09-23T12:56:12Z",
    "updatedAt": "2025-06-30T14:34:07Z"
}

json

HTTP response status codes

Status code	Description
`200`	The request was successful

List games for an establishment

Retrieve games list for an establishment.

Path to list games for an establishment

GET

/establishment/:establishmentId/games

Parameters to list games for an establishment

Headers

Field	Type	Required	Description
`Authorization`	string	Required	The Bearer access token (`Bearer :accessToken`)

Authorization

Bearer ab2d160d-0056-4eba-b271-3f02d50c6ae8

Path parameters

Parameter	Type	Required	Description
`establishmentId`	string	Required	The establishment identifier

GET

/establishment/adcca7e4-5941-470b-b391-d91c5298fa36/games

JSON Response body

Type: Array<Game>

Game fields (for each array item):

Field	Type	Required	Description
`gameId`	string	Required	The game identifier
`language`	string	Required	The language code (in ISO 639-1 format)
`additionalLanguages`	Array<string>		The additional languages code (in ISO 639-1 format)
`name`	string	Required	The game name
`nameTranslated`	Map<string, string>		The game name in additional languages
`description`	string		The game description
`link`	string	Required	The game link
`establishmentId`	string	Required	The establishment identifier
`status`	string	Required	The game status (`ACTIVE` or `INACTIVE`)
`gameType`	string	Required	The game type (`WHEEL`, `CARDS` or `SCRATCH_CARD`)
`createdAt`	string	Required	The creation date (in ISO 8601 format)
`updatedAt`	string		The last update date (in ISO 8601 format)

[
    {
        "gameId": "e90b16e6-e1c2-410d-ba79-706d4e3159ce",
        "status": "ACTIVE",
        "gameType": "CARDS",
        "establishmentId": "a2673bdc-3d24-4890-816c-2f5c02de156e",
        "language": "fr",
        "name": "Cartes !!",
        "description": "",
        "link": "https://gg.suggpro.com/wnmR",
        "createdAt": "2025-03-18T11:01:12Z",
        "updatedAt": "2025-03-18T11:02:30Z"
    },
    {
        "gameId": "adcca7e4-5941-470b-b391-d91c5298fa36",
        "status": "ACTIVE",
        "gameType": "SCRATCH_CARD",
        "establishmentId": "a2673bdc-3d24-4890-816c-2f5c02de156e",
        "language": "fr",
        "name": "Gratte Gratte !",
        "description": "",
        "link": "https://gg.suggpro.com/F7Gq",
        "createdAt": "2025-03-31T14:55:11Z",
        "updatedAt": "2025-05-06T10:16:58Z"
    },
    {
        "gameId": "4140521d-b6cd-4340-b6d6-334104cd5242",
        "status": "ACTIVE",
        "gameType": "WHEEL",
        "establishmentId": "a2673bdc-3d24-4890-816c-2f5c02de156e",
        "language": "fr",
        "additionalLanguages": [
            "en",
            "de"
        ],
        "name": "Info",
        "nameTranslated": {
            "de": "Info",
            "en": "Info"
        },
        "description": "Jeux multilangue",
        "link": "https://gg.suggpro.com/W12V",
        "createdAt": "2024-11-06T15:31:39Z",
        "updatedAt": "2025-12-12T14:38:38Z"
    }
]

json

HTTP response status codes

Status code	Description
`200`	The request was successful

Last update at: 2025/12/12 15:47:47

On this page

Getting Started Base API endpoint Request an API access token Register player Path to register a player Parameters to register a player Headers Path parameters JSON Body parameters JSON Response body HTTP response status codes Get company information Path to get company information Parameters to get company information Headers JSON Response body HTTP response status codes List games Path to list games Parameters to list games Headers JSON Response body HTTP response status codes List establishments Path to list establishments Parameters to list establishments Headers JSON Response body HTTP response status codes Get establishment information Path to get establishment information Parameters to get establishment information Headers Path parameters JSON Response body HTTP response status codes List games for an establishment Path to list games for an establishment Parameters to list games for an establishment Headers Path parameters JSON Response body HTTP response status codes