Retrieve game passes for a specific app

post https://us-central1-readysandbox.cloudfunctions.net/gamePass-getForApp

Responses

Response body

object

gamePasses

array of objects

gamePasses

object

string

required

Unique identifier for the Game Pass.

appIds

array of strings

required

List of application identifiers that are included in this Game Pass.

appIds*

requestName

string

required

The name used for server requests related to this Game Pass.

name

string

required

The display name of the Game Pass.

description

string

required

Detailed description of the Game Pass.

setBy

string

Defines who can add/remove the Game Pass to/from the user: - client - the client and the server can add/remove the Game Pass to/from the user. - server - only the server can add/remove the Game Pass to/from the user.

linkedVirtualItems

array of strings

List of virtual item identifiers that are providing this game pass when purchased.

linkedVirtualItems

createdAt

int64

required

The UNIX timestamp representing when the Game Pass was created in milliseconds since midnight, January 1, 1970 UTC. This field is automatically populated by the backend.

updatedAt

int64

required

The UNIX timestamp representing when the Game Pass was last updated in milliseconds since midnight, January 1, 1970 UTC. This field is automatically populated by the backend.

createdBy

string

required

Identifier for the user who created the Game Pass. This field is automatically populated by the backend.

updatedBy

string

required

Identifier for the user who last updated the Game Pass. This field is automatically populated by the backend.

400

Invalid argument error for invalid appId.

410

Not Found error indicating there are no game passes for the specified app.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://us-central1-readysandbox.cloudfunctions.net/gamePass-getForApp \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
21
 
1
{
2
  "gamePasses": [
3
    {
4
      "id": "string",
5
      "appIds": [
6
        "string"
7
      ],
8
      "requestName": "string",
9
      "name": "string",
10
      "description": "string",
11
      "setBy": "string",
12
      "linkedVirtualItems": [
13
        "string"
14
      ],
15
      "createdAt": 0,
16
      "updatedAt": 0,
17
      "createdBy": "string",
18
      "updatedBy": "string"
19
    }
20
  ]
21
}

200Successful response with a list of game passes for the specified app.

401Unauthenticated error 401 indicating the user is not authenticated.