Skip to content

Get Queue

GET
/v1/sandbox/{sandbox_id}/queue/{queue_id}

Get a specific Queue for a sandbox

Requires any of permissions: sandbox:config:view, sandbox:config:edit

Authorizations

Parameters

Path Parameters

queue_id
required
string format: uuid
sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Responses

200

Successful Response

object
active
required

Flag for whether or not the queue is active, and can be joined or sessions created from it

boolean
max_queue_group_size
required

The maximum size of a group that can join this queue

integer
>= 1
match_making_template_group_id
required

ID for which group of matchmaking templates/rules will be used when joining this queue

string format: uuid
legacy_config

Old config used by Legacy systems. These values are ignored by the current APIs

object
queue_id

Old queue id

integer
sandbox_id

ID of the Sandbox

string format: uuid
last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
created_timestamp

Timestamp of when this resource was created

string format: date-time
queue_id
required

ID to uniquely identify this queue

string format: uuid

422

Validation Error

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