Skip to content
RallyHere Docs

Get Single Player Uuid Setting Self

GET
/settings/v2/player/me/setting_type/{setting_type_id}/key/{key}

Get a single player setting

Required Permissions: setting:read or setting:read:self

Authorizations

Parameters

Path Parameters

setting_type_id
required

Setting Type to get settings for. Must be one of the known setting types

string
>= 1 characters <= 128 characters

Setting Type to get settings for. Must be one of the known setting types

key
required

Setting Key to get settings for

string
>= 1 characters <= 256 characters

Setting Key to get settings for

Responses

200

Successful Response

Setting version/value data from a specific setting type/key for a player

object
v
required

Setting Version

integer
value

Setting Value document

400

Error Codes:

  • setting_type_not_supported - The setting type is not supported at this time. Contact an administrator
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

403

Forbidden

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

404

Error Codes:

  • setting_type_id_not_found - The setting type ID was not found
  • not_found - The setting key was not found
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