Skip to content

Get Xp By Id

GET
/v1/sandbox/{sandbox_id}/xp/{xp_id}

Get Xp by ID. Requires any of permissions: sandbox:config:view, sandbox:config:edit

Authorizations

Parameters

Path Parameters

xp_id
required

Xp ID

string format: uuid

Xp ID

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Responses

200

Successful Response

A collection of XP Thresholds. Thresholds are sorted by XP Threshold value.

XP Levels can be skipped by setting a XP Threshold value to be the same as the previous XP Threshold value. Example: Thresholds: 100, 200, 300 will correspond to XP Level 1 at 100 XP, XP Level 2 at 200 XP, and XP Level 3 at 300 XP. To skip level 2, insert another XP Threshold with the value 200. This will cause level 2 and level 3 to be at 200 XP effectively skipping level 2.

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
xp_thresholds

The XP Thresholds.

Array<object>
default:

An XP Level threshold. This is used to determine the next XP Level.

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
xp_level_threshold
required

The XP Threshold value.

integer
xp_level_threshold_id
required

The ID of the XP Threshold.

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 the resource was created

string format: date-time
xp_id
required

The ID of the XP.

string format: uuid
legacy_xp_id
required

The legacy ID of the XP.

integer

422

Validation Error

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