Skip to content

Get Match Making Profile V2

GET
/session/v2/match-making-profile/{match_making_profile_id}

Get info about a specific match making profile

Required Permissions:

  • For any player (including themselves) any of: session:*, session:read:config

Required Session Permissions: None

Authorizations

Parameters

Path Parameters

match_making_profile_id
required
string
>= 1 characters <= 128 characters

Header Parameters

if-none-match

If you provide the ETag that matches the current ETag for this resource, a 304 response will be returned - indicating that the resource has not changed.

string

If you provide the ETag that matches the current ETag for this resource, a 304 response will be returned - indicating that the resource has not changed.

Responses

200

Successful Response

A profile that describes what pools of players a session will be a part of when matchmaking

object
match_making_profile_id
required

ID of the matchmaking profile to join

string
>= 1 characters <= 128 characters
join_mode

What mode to set on the matchmaking profile (normal, backfill etc)

string
Allowed values: normal backfill created_before
instance_request_template_id
required

Which instance template to use when launching a match in this profile

string format: uuid
rank_id

Which rank this profile should use MMR from to make matches from, and update at the end of match (1v1 MMR or 2v2 MMR for example)

string
num_sides

The number of sides a game in this profile will have (2 in a 1v1 and 3 in a 1v1v1 for example

integer
max_players_per_side

The maximum number of players that can be on each team

integer
min_players_per_side

The minimum number of players that can be on each team

integer
legacy_config

Legacy config to help migrate clients

object

Headers

ETag
string

Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string