Get joinable open matches

post https://us-central1-readysandbox.cloudfunctions.net/matchmaking-getJoinOpenMatches

Responses

Response body

object

matches

array of objects

matches

object

string

required

Unique identifier of the matchmaking process.

appId

string

required

Identifier of the application where the matchmaking process is running.

type

string

Defaults to default

Specifies the type of the match. Currently, only "default" is supported.

finishType

string

Defaults to scoreSubmitBased

Defines how the match is finished. It can be "manual" (requires calling a specific method), "scoreSubmitBased" (automatically finishes once all participants submit their scores), or "timeBased" (automatically finishes based on time condition).

startType

string

Defaults to matchFillBased

Defines how the match is started. It can be "manual" (needs to be started by calling a specific method), "matchFillBased" (automatically starts once all participant slots are filled), or "timeBased" (automatically starts based on time condition).

maxUsers

integer

Defaults to 2

Specifies the maximum number of users that can participate in the matchmaking process.

isStarted

boolean

Indicates whether the matchmaking process has been started.

votingEnabled

boolean

Defaults to false

Determines whether voting is enabled during the matchmaking process.

oncePerUserVoting

boolean

Defaults to true

Specifies whether a user can vote only once during the matchmaking process.

createdBy

string

The identifier of the user who initiated the matchmaking process. This field is automatically populated by the backend.

updatedBy

string

The identifier of the user who updated the matchmaking process data. This field is automatically populated by the backend.

createdAt

int64

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

updatedAt

int64

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

participants

array of strings

A list of identifiers of users who are participating in the matchmaking process.

participants

votes

array of objects

A list of votes cast during the matchmaking process.

votes

object

voterId

string

required

The identifier of the voter.

participantId

string

required

The identifier of the participant that the vote is for.

participantsScore

object

A dictionary mapping the participant identifiers to their respective scores in the matchmaking process.

Has additional fields

participantsPayload

object

A dictionary mapping the participant identifiers to their respective optional payload data in the matchmaking process.

participationFees

array of objects

A list of participation fees for the matchmaking process.
The fees are deducted when the user joins the match (participateInMatch).

participationFees

object

type

string

required

Specifies the type of the participation fee.
Available types are:

currency - the user needs to pay a specific amount of currency to join a leaderboard.
gamepass_by_id - the user needs to have a gamepass with a specific id to join a leaderboard.
gamepass_by_request_name - the user needs to have a gamepass with a specific request name to join a
leaderboard.

currency gamepass_by_id gamepass_by_request_name

string

required

The id of the entity to check in user data. For example, if the type is gamepass_by_id, the id is the id of the gamepass. If the type is gamepass_by_request_name, the id is the request name of the gamepass.

quantity

integer

≥ 1

The quantity of the entity to check in user data. For example, if the type is currency, the quantity is the amount of currency. If the type is gamepass_by_id, the quantity is the quantity of the game passes the user needs to have.

400

Bad request, if the provided parameters are incorrect.

Language

Credentials

URL


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


xxxxxxxxxx
41
}
1
{
2
  "matches": [
3
    {
4
      "id": "string",
5
      "appId": "string",
6
      "type": "default",
7
      "finishType": "scoreSubmitBased",
8
      "startType": "matchFillBased",
9
      "maxUsers": 2,
10
      "isStarted": true,
11
      "votingEnabled": false,
12
      "oncePerUserVoting": true,
13
      "createdBy": "string",
14
      "updatedBy": "string",
15
      "createdAt": 0,
16
      "updatedAt": 0,
17
      "participants": [
18
        "string"
19
      ],
20
      "votes": [
21
        {
22
          "voterId": "string",
23
          "participantId": "string"
24
        }
25
      ],

200Successful response with a list of matches.

401Unauthenticated error 401 indicating the user is not authenticated.