Admin API

List Notifications

GET

/admin/game/{game_id}/notifications/v1/

notifications

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.lootlocker.io/admin/game//notifications/v1/?per_page=10&page=1&priority=medium&notification_type=pull.reward.acquired&read=true&source=purchasing.apple_app_store&custom=true' \
--header 'x-auth-token;'

Response Example

{
  "notifications": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "expiration_date": "2019-08-24T14:15:22Z",
      "read_at": "2019-08-24T14:15:22Z",
      "notification_type": "string",
      "priority": "string",
      "source": "purchasing.apple_app_store",
      "content": {
        "context": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "body": {
          "kind": "group",
          "group": {
            "created_at": "string",
            "name": "string",
            "description": "string",
            "associations": [
              {
                "kind": "string",
                "group": null,
                "currency": {
                  "created_at": "string",
                  "updated_at": "string",
                  "amount": "string",
                  "details": {
                    "name": "string",
                    "code": "string",
                    "amount": "string",
                    "id": "string"
                  },
                  "reward_id": "string",
                  "currency_id": "string"
                },
                "progression_reset": {
                  "created_at": "string",
                  "updated_at": "string",
                  "details": {
                    "key": "string",
                    "name": "string",
                    "id": "string"
                  },
                  "progression_id": "string",
                  "reward_id": "string"
                },
                "progression_points": {
                  "created_at": "string",
                  "updated_at": "string",
                  "details": {
                    "key": "string",
                    "name": "string",
                    "amount": 0,
                    "id": "string"
                  },
                  "amount": 0,
                  "progression_id": "string",
                  "reward_id": "string"
                },
                "asset": {
                  "created_at": "string",
                  "updated_at": "string",
                  "details": {
                    "name": "string",
                    "thumbnail": null,
                    "variation_name": null,
                    "rental_option_name": null,
                    "variation_id": null,
                    "rental_option_id": null,
                    "legacy_id": 0,
                    "id": "string"
                  },
                  "asset_variation_id": null,
                  "asset_rental_option_id": null,
                  "asset_id": 0,
                  "reward_id": "string",
                  "asset_ulid": "string"
                }
              }
            ],
            "reward_id": "string"
          },
          "currency": null,
          "progression_reset": null,
          "progression_points": null,
          "asset": null
        }
      },
      "id": {},
      "player_id": {},
      "read": true
    }
  ],
  "pagination": {
    "errors": [
      {
        "field": "string",
        "message": "string"
      }
    ],
    "per_page": 0,
    "offset": 0,
    "total": 0,
    "last_page": 0,
    "current_page": 0,
    "next_page": 0,
    "prev_page": 0
  }
}

Request

Authorization

API Key

Add parameter in header

x-auth-token

Example:

x-auth-token: ********************

Path Params

game_id

string

required

Query Params

per_page

integer <uint64>

optional

>= 1

Example:

page

integer <uint64>

optional

>= 1

Example:

priority

enum<string>

optional

Allowed values:

lowmediumhighemergency

Default:

medium

Example:

medium

notification_type

enum<string>

optional

Allowed value:

pull.reward.acquired

Example:

pull.reward.acquired

read

boolean

optional

Example:

true

source

enum<string>

optional

Allowed values:

purchasing.apple_app_storepurchasing.google_play_storepurchasing.steam_storepurchasing.lootlockertriggerslootlocker.consolelootlocker.server_api

Example:

purchasing.apple_app_store

custom

string

required

Optional. true If you want to restrict notifications to custom ones, false to view only automated notifications.

Example:

true

Header Params

x-auth-token

string

optional

Example:

Responses

🟢200OK

application/json

Body

notifications

array [object {10}] | null

required

created_at

string <date-time>

required

The time that this notification was created

expiration_date

string <date-time>

required

At what time that this notification expires

read_at

string <date-time> | null

optional

The time that this notification was acknowledged. Will be empty if the notification has not been acknowledged

notification_type

string

required

The type of this notification

Match pattern:

^[a-z_-]+\.[a-z_-]+\.[a-z_-]+$

priority

string

required

The priority of this notification (default: medium)

source

enum<string>

required

The originating source of this notification (for example, did it originate from a purchase, a leaderboard reward, or a trigger?)

Allowed values:

purchasing.apple_app_storepurchasing.google_play_storepurchasing.steam_storepurchasing.playstation_networkpurchasing.nintendo_eshoppurchasing.lootlockerpurchasing.stripe_storetriggerslootlocker.consolelootlocker.server_api

content

object

required

object

required

player_id

object

required

read

boolean

required

Whether this notification has been acknowledged or not

pagination

object (Offset Pagination)

required

errors

array [object {2}] | null

required

If the values provided don't allow for pagination to happen, errors will be indicated within this array.

per_page

integer <uint64>

required

>= 0

offset

integer <uint64>

required

How far you are within the total set of records.

>= 0

total

integer <uint64>

required

How many items total were found.

>= 0

last_page

integer <uint64>

required

>= 0

current_page

integer <uint64>

required

>= 0

next_page

integer <uint64> | null

required

>= 0

prev_page

integer <uint64> | null

required

>= 0

Modified at 2025-04-09 09:13:56

Send Notification to Player