Get FRB Templates

Get FRB Templates

Retrieve a paginated list of FRB templates for a given operator.

Request endpoint: /frb/{version}/templates/{groove_operator_id}?subProvider=1&page=N&limit=N

Request Method: GET

Usage information:

Returns all FRB templates belonging to the specified operator. Results are paginated.

Note

This request requires an authorization token: Bearer authorization token.
Token Format: The authorization token must be Base64-encoded as follows:
AuthorizationToken = encode(back_office_email:back_office_password)

Info

When subProvider=1 is set, only templates that were created through the standard flow are returned. Each template entry shows providerName and providerId reflecting the provider used at creation time.

Request parameters:

Parameter Data type Description
version String required The API version. Only version 1.0 is currently supported. Other version values are accepted, but are treated as 1.0.
Example: v1
groove_operator_id Integer required Groove operator ID (path parameter).
subProvider Integer required Must be 1. Ensures each template in the response shows the correct providerName and providerId.
page Integer optional Page number for pagination (1-based). Defaults to 1.
limit Integer optional Number of templates per page. Defaults to 10.
Authorization Yes (Header) Sinatra back office user

Example Response

Success response

{
  "templates": [
    {
      "id": "663b1f77bcf86cd799439044",
      "done": true,
      "offer_names": ["WelcomeBonus"],
      "succeeded_providers": ["BetSoft"],
      "failed_providers": [],
      "succeeded_insertion": [
        {
          "id": "663b1f77bcf86cd799439045",
          "templateId": "TMP_82600118_11_BetSoft",
          "providerName": "BetSoft",
          "providerId": 82,
          "operatorId": 11,
          "transactionId": "",
          "numberOfRounds": 10,
          "availableFromDate": "2026-04-29 00:00:00",
          "availableDuration": 7,
          "expirationDate": "2026-05-06 00:00:00",
          "offerName": "WelcomeBonus",
          "gameInfoList": [
            {
              "gameId": "82600118",
              "betAmount": [100]
            }
          ],
          "exceptionResponses": [],
          "players": []
        }
      ],
      "failed_insertion": []
    },
    {
      "id": "663b1f77bcf86cd799439055",
      "done": true,
      "offer_names": ["SummerPromo"],
      "succeeded_providers": ["Wazdan"],
      "failed_providers": [],
      "succeeded_insertion": [
        {
          "id": "663b1f77bcf86cd799439056",
          "templateId": "TMP_95000012_11_Wazdan",
          "providerName": "Wazdan",
          "providerId": 95,
          "operatorId": 11,
          "transactionId": "",
          "numberOfRounds": 5,
          "availableFromDate": "2026-04-29 00:00:00",
          "availableDuration": 14,
          "expirationDate": "2026-05-13 00:00:00",
          "offerName": "SummerPromo",
          "gameInfoList": [
            {
              "gameId": "95000012",
              "betAmount": [50]
            }
          ],
          "exceptionResponses": [],
          "players": []
        }
      ],
      "failed_insertion": []
    }
  ],
  "page": 1,
  "limit": 10,
  "total": 2
}
Info
  • templates is the paginated list. Each entry has the same structure as the response from the Create FRB Template endpoint.
  • providerName and providerId in each succeeded_insertion entry reflect the provider used when the template was created.
  • page, limit, and total fields support client-side pagination.

Error Response:

{
  "errMsg": "bad request"
}

Response codes:

Code Status Message
200 success Templates retrieved
400 bad request bad request
403 forbidden access forbidden access
500 internal server error internal server error