Skip to content
RallyHere Docs

Get Crossplay Pool Tags For Pool

GET
/v1/sandbox/{sandbox_id}/crossplay-pool/{crossplay_pool_id}/crossplay-pool-tag

Get all CrossplayPoolTags in a specific CrossplayPool for a sandbox Requires any of permissions: sandbox:config:view, sandbox:config:edit

Authorizations

Parameters

Path Parameters

crossplay_pool_id
required
string format: uuid
sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Query Parameters

page_size

The maximum number of elements to be returned per call

integer
default: 50 >= 1 <= 10000

The maximum number of elements to be returned per call

cursor

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
default: 0 >= 1 characters <= 128 characters

Cursor to designate where you are in iterating through values. Start with '0', and pass this on subsequent calls to continue iteration

Responses

200

Successful Response

object
cursor
required

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
>= 1 characters <= 128 characters
tags
required

List of CrossplayPoolTagss

Array<object>

This mixin is meant to give a set of common properties to root config models

object
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
custom_data

Custom data associated with the resource

object
key
additional properties
string
tag
required

The open-match tag to be added to the specific pool

string
>= 1 characters <= 50 characters
crossplay_pool_id
required

Which CrossplayPool this CrossplayPoolTag belongs to

string format: uuid
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
crossplay_pool_tag_id
required

ID to uniquely identify this CrossplayPoolTag

string format: uuid

422

Validation Error

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