Get External Key Campaigns

GET

/v1/sandbox/{sandbox_id}/external-key-campaign

Get External Key Campaigns by filters. All filters must be true for an External Key Campaign to be returned. Requires any of permissions: sandbox:config:view, sandbox:config:edit

Authorizations

• RallyHereHTTPBearer

Parameters

Path Parameters

sandbox_id

required

Sandbox ID

string format: uuid

Sandbox ID

Query Parameters

external_key_campaign_ids

External Key Campaign IDs to filter by

Array<string>

default:

External Key Campaign IDs to filter by

key_types

Filter by External Key Campaign with matching key types

Array<string>

default:

Filter by External Key Campaign with matching key types

name

Filter by case insensitive name

string

>= 1 characters <= 50 characters

Filter by case insensitive name

last_modified_account_ids

Filter by last modified account ID

Array<string>

default:

Filter by last modified account ID

sort_by

Sort results by

string

Allowed values: external_key_campaign_id name

Sort results by

sort_order

Sort order

string

Allowed values: asc desc

Sort order

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

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

Responses

200

Successful Response

A collection of External Key Campaigns.

object

data

The External Key Campaigns.

Array<object>

default:

A campaign to distribute external keys to players.

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

key_types

The types of keys that can be distributed by this campaign.

Array<string>

default:

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

external_key_campaign_id

required

The External Key Campaign ID.

string format: uuid

page_meta

required

The paging metadata.

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

page_size

The maximum number of elements to be returned per call

integer

default: 50 >= 1 <= 10000

total

The total number of entities.

integer

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string