Tanitar Developers

This reference is generated from the controllers mounted by Tanitar's services. It contains the API-key surface available to your back end. The public Player allowlist is currently empty and will appear here when that API is released.

Every operation names the API that owns it, the base-URL placeholder that API is served from, the scope your key must carry, its parameters, its request body, and whether it requires an Idempotency-Key header. See Authentication for the base URL behind each placeholder and for how scopes are granted to a key.

The generated code samples use a placeholder host. Do not send requests to it. Each operation names the base URL to use, such as $REWARD_API_URL or $TOURNAMENT_API_URL. Request execution from this page is intentionally disabled.

Error responses follow one shape across every API, documented under each operation's 401, 403, 429 and default responses. Success response bodies are not yet described field by field here; the guide for each capability shows a worked response until the services publish those schemas.

Check in enrollment

POST/enrollments/{enrollmentId}/check-in

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

enrollmentId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/enrollments/string/check-in" \  -H "Idempotency-Key: string"

Empty

Confirm enrollment

POST/enrollments/{enrollmentId}/confirm

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

enrollmentId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/enrollments/string/confirm" \  -H "Idempotency-Key: string"

Empty

Accept roster

POST/enrollments/{enrollmentId}/roster/{rosterMemberId}/accept

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

enrollmentId*string

rosterMemberId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/enrollments/string/roster/string/accept" \  -H "Idempotency-Key: string"

Empty

Reject roster

POST/enrollments/{enrollmentId}/roster/{rosterMemberId}/reject

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

enrollmentId*string

rosterMemberId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/enrollments/string/roster/string/reject" \  -H "Idempotency-Key: string"

Empty

Withdraw enrollment

POST/enrollments/{enrollmentId}/withdraw

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

enrollmentId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/enrollments/string/withdraw" \  -H "Idempotency-Key: string"

Empty

Delete enrollment

DELETE/enrollments/{enrollmentId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

enrollmentId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/enrollments/string" \  -H "Idempotency-Key: string"

Empty

Update enrollment

PATCH/enrollments/{enrollmentId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

enrollmentId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PATCH "https://example.com/enrollments/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Create enrollment

POST/enrollments

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/enrollments" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Complete upload

POST/esports-organizations/{esportsOrganizationId}/media/{kind}/uploads/{uploadId}/complete

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

esportsOrganizationId*string

kind*string

uploadId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/esports-organizations/string/media/string/uploads/string/complete" \  -H "Idempotency-Key: string"

Empty

Create upload

POST/esports-organizations/{esportsOrganizationId}/media/{kind}/uploads

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

esportsOrganizationId*string

kind*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/esports-organizations/string/media/string/uploads" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Delete esports organization media

DELETE/esports-organizations/{esportsOrganizationId}/media/{kind}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

esportsOrganizationId*string

kind*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/esports-organizations/string/media/string" \  -H "Idempotency-Key: string"

Empty

Read media

GET/esports-organizations/{esportsOrganizationId}/media/{kind}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

esportsOrganizationId*string

kind*string

Response Body

`application/json`

curl -X GET "https://example.com/esports-organizations/string/media/string"

Empty

Remove esports organization member

DELETE/esports-organizations/{esportsOrganizationId}/members/{memberId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

esportsOrganizationId*string

memberId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/esports-organizations/string/members/string" \  -H "Idempotency-Key: string"

Empty

Assign esports organization member

POST/esports-organizations/{esportsOrganizationId}/members

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

esportsOrganizationId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/esports-organizations/string/members" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Delete esports organization role

DELETE/esports-organizations/{esportsOrganizationId}/roles/{roleKey}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

esportsOrganizationId*string

roleKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/esports-organizations/string/roles/string" \  -H "Idempotency-Key: string"

Empty

Create esports organization role

POST/esports-organizations/{esportsOrganizationId}/roles

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

esportsOrganizationId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/esports-organizations/string/roles" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Delete esports organization

DELETE/esports-organizations/{esportsOrganizationId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

esportsOrganizationId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/esports-organizations/string" \  -H "Idempotency-Key: string"

Empty

Read esports organization

GET/esports-organizations/{esportsOrganizationId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

esportsOrganizationId*string

Response Body

`application/json`

curl -X GET "https://example.com/esports-organizations/string"

Empty

Update esports organization

PATCH/esports-organizations/{esportsOrganizationId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

esportsOrganizationId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PATCH "https://example.com/esports-organizations/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List esports organizations

GET/esports-organizations

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Query Parameters

cursor*string

Response Body

`application/json`

curl -X GET "https://example.com/esports-organizations?cursor=string"

Empty

Create esports organization

POST/esports-organizations

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/esports-organizations" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List event crew candidates

GET/event-crew-candidates

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/event-crew-candidates"

Empty

Read event credential history

GET/events/{eventId}/badges/{issueId}/history

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:badges:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

issueId*string

Query Parameters

historyCursor*string

deliveryCursor*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/badges/string/history?historyCursor=string&deliveryCursor=string"

Empty

Create event credential print link

POST/events/{eventId}/badges/{issueId}/print-link

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:badges:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

issueId*string

Response Body

`application/json`

curl -X POST "https://example.com/events/string/badges/string/print-link"

Empty

Resend event credential email

POST/events/{eventId}/badges/{issueId}/resend

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:badges:mutate · Requires an Idempotency-Key header

Clerk callers must be organization administrators. API-key callers require the declared scopes; a Clerk organization role is not required for API keys.

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

issueId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

operationId*string

Length1 <= length <= 160

Response Body

`application/json`

curl -X POST "https://example.com/events/string/badges/string/resend" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "operationId": "string"  }'

Empty

Revoke event credential

POST/events/{eventId}/badges/{issueId}/revoke

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:badges:mutate · Requires an Idempotency-Key header

Clerk callers must be organization administrators. API-key callers require the declared scopes; a Clerk organization role is not required for API keys.

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

issueId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

revision*integer

Range1 <= value

Response Body

`application/json`

curl -X POST "https://example.com/events/string/badges/string/revoke" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "revision": 1  }'

Empty

List event credential definitions

GET/events/{eventId}/badges/definitions

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:badges:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Query Parameters

cursor*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/badges/definitions?cursor=string"

Empty

Save event credential definition

PUT/events/{eventId}/badges/definitions

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:badges:mutate · Requires an Idempotency-Key header

Clerk callers must be organization administrators. API-key callers require the declared scopes; a Clerk organization role is not required for API keys.

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

definitionId*string

Length1 <= length <= 160

category*string

Length1 <= length <= 100

templateId*string

Length1 <= length <= 160

templateRevision*integer

Range1 <= value

expectedRevision*integer

Range0 <= value

enabled*boolean

validFrom?string

Formatdate-time

validUntil?string

Formatdate-time

Response Body

`application/json`

curl -X PUT "https://example.com/events/string/badges/definitions" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "definitionId": "string",    "category": "string",    "templateId": "string",    "templateRevision": 1,    "expectedRevision": 0,    "enabled": true  }'

Empty

Issue event credential

POST/events/{eventId}/badges/issues

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:badges:mutate · Requires an Idempotency-Key header

Clerk callers must be organization administrators. API-key callers require the declared scopes; a Clerk organization role is not required for API keys.

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

definitionId*string

Length1 <= length <= 160

playerId*string

Length1 <= length <= 160

issuanceKey*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/events/string/badges/issues" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "definitionId": "string",    "playerId": "string",    "issuanceKey": "string"  }'

Empty

Retry event credential bulk job

POST/events/{eventId}/badges/jobs/{jobId}/retry

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:badges:mutate · Requires an Idempotency-Key header

Clerk callers must be organization administrators. API-key callers require the declared scopes; a Clerk organization role is not required for API keys.

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

jobId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/events/string/badges/jobs/string/retry" \  -H "Idempotency-Key: string"

Empty

Read event credential bulk job

GET/events/{eventId}/badges/jobs/{jobId}

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:badges:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

jobId*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/badges/jobs/string"

Empty

Create event credential bulk job

POST/events/{eventId}/badges/jobs

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:badges:mutate · Requires an Idempotency-Key header

Clerk callers must be organization administrators. API-key callers require the declared scopes; a Clerk organization role is not required for API keys.

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

definitionId*string

Length1 <= length <= 160

jobId*string

Length1 <= length <= 160

selector*string

Value in

"registered"
"crew"

role?string

Value in

"event_admin"
"event_manager"
"event_editor"
"media_manager"
"event_coordinator"

Response Body

`application/json`

curl -X POST "https://example.com/events/string/badges/jobs" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "definitionId": "string",    "jobId": "string",    "selector": "registered"  }'

Empty

List event credential templates

GET/events/{eventId}/badges/templates

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:badges:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Query Parameters

cursor*string

Response Body

`application/json`

curl -X GET "https://example.com/events/{eventId}/badges/templates?cursor=string"

Empty

Save event credential template

PUT/events/{eventId}/badges/templates

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:badges:mutate · Requires an Idempotency-Key header

Clerk callers must be organization administrators. API-key callers require the declared scopes; a Clerk organization role is not required for API keys.

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

templateId*string

Length1 <= length <= 160

expectedRevision*integer

Range0 <= value

title*string

Length1 <= length <= 100

design*

At most 65536 UTF-8 bytes. Coordinates and dimensions are percentages; every element must fit inside the page. Image references must belong to this event.

archived*boolean

Response Body

`application/json`

curl -X PUT "https://example.com/events/string/badges/templates" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "templateId": "string",    "expectedRevision": 0,    "title": "string",    "design": {      "pageSize": "A4",      "orientation": "portrait",      "font": "inter",      "color": "string",      "background": "string",      "elements": [        {          "type": "text",          "x": 0,          "y": 0,          "width": 1,          "height": 1        }      ]    },    "archived": true  }'

Empty

List event credentials

GET/events/{eventId}/badges

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:badges:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Query Parameters

cursor*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/badges?cursor=string"

Empty

Delete crew

DELETE/events/{eventId}/crew/{playerId}

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

playerId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

eventRevision*integer

Range1 <= value

revision*integer

Range1 <= value

Response Body

`application/json`

curl -X DELETE "https://example.com/events/string/crew/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "eventRevision": 1,    "revision": 1  }'

Empty

Update crew

PATCH/events/{eventId}/crew/{playerId}

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

playerId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

playerId*string

Length1 <= length <= 160

role*string

Value in

"event_admin"
"event_manager"
"event_editor"
"media_manager"
"event_coordinator"

eventRevision*integer

Range1 <= value

revision*integer

Range0 <= value

Response Body

`application/json`

curl -X PATCH "https://example.com/events/string/crew/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "playerId": "string",    "role": "event_admin",    "eventRevision": 1,    "revision": 0  }'

Empty

Read crew

GET/events/{eventId}/crew

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/crew"

Empty

Create crew

POST/events/{eventId}/crew

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

playerId*string

Length1 <= length <= 160

role*string

Value in

"event_admin"
"event_manager"
"event_editor"
"media_manager"
"event_coordinator"

eventRevision*integer

Range1 <= value

revision*integer

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/events/string/crew" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "playerId": "string",    "role": "event_admin",    "eventRevision": 1,    "revision": 0  }'

Empty

Complete event media upload

POST/events/{eventId}/media/{kind}/uploads/{uploadId}/complete

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

kind*string

uploadId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedMediaRevision*integer

Range0 <= value <= 9007199254740990

Response Body

`application/json`

curl -X POST "https://example.com/events/string/media/string/uploads/string/complete" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedMediaRevision": 0  }'

Empty

Start event media upload

POST/events/{eventId}/media/{kind}/uploads

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

kind*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Authorize a ten-minute staging upload. Completion verifies the bytes and promotes them to a distinct final public URL. Only the initiating principal on the same plane can complete it.

contentType*unknown

Value in

"image/jpeg"
"image/png"
"image/webp"

contentLength*integer

Range1 <= value <= 10485760

checksumSha256*string

Match^[a-fA-F0-9]{64}$

replaceMediaId?string

Match^med_[A-Za-z0-9_-]{1,128}$

Response Body

`application/json`

curl -X POST "https://example.com/events/string/media/string/uploads" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "contentType": "image/jpeg",    "contentLength": 1,    "checksumSha256": "string"  }'

Empty

Remove event cover

DELETE/events/{eventId}/media/cover

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedMediaRevision*integer

Range0 <= value <= 9007199254740990

Response Body

`application/json`

curl -X DELETE "https://example.com/events/string/media/cover" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedMediaRevision": 0  }'

Empty

Remove event gallery photo

DELETE/events/{eventId}/media/gallery/{mediaId}

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

mediaId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedMediaRevision*integer

Range0 <= value <= 9007199254740990

Response Body

`application/json`

curl -X DELETE "https://example.com/events/string/media/gallery/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedMediaRevision": 0  }'

Empty

Reorder event gallery

PUT/events/{eventId}/media/gallery/order

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedMediaRevision*integer

Range0 <= value <= 9007199254740990

mediaIds*array<string>

Itemsitems <= 12

Response Body

`application/json`

curl -X PUT "https://example.com/events/string/media/gallery/order" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedMediaRevision": 0,    "mediaIds": [      "string"    ]  }'

Empty

Read event media

GET/events/{eventId}/media

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/media"

Empty

Save event page design

PUT/events/{eventId}/page/draft

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:pages:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedHeadRevision*number

Current head revision; zero for the first save

Range0 <= value <= 9007199254740991

operationId*string

Must equal the Idempotency-Key header

Lengthlength <= 256

config*|

Response Body

`application/json`

curl -X PUT "https://example.com/events/string/page/draft" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedHeadRevision": 0,    "operationId": "string",    "config": {      "schemaVersion": 1,      "type": "event_page_design",      "catalogVersion": 1,      "look": {        "readyMadeLook": "defendr",        "layout": "classic",        "backdrop": "none",        "title": "solid",        "surface": "neutral",        "hideDefendrMenu": true,        "hideFooter": true,        "primaryColor": "strings"      },      "pattern": {        "designPattern": "clean",        "behindTheTop": "nothing",        "aroundTheTop": "nothing",        "titles": "bar",        "betweenSections": "nothing",        "cardsAndPictures": "plain",        "buttonsAndLabels": "plain"      },      "typeAndShapes": {        "headingTypeface": "default",        "textTypeface": "default",        "headings": "capitals",        "corners": "sharp",        "cards": "solid",        "buttons": "solid",        "secondColor": "strings"      },      "artwork": {},      "sections": {        "sectionMenu": true,        "items": []      }    }  }'

{  "success": true,  "data": {    "eventId": "string",    "headRevision": 0,    "draftRevision": 1,    "publishedRevision": 1  },  "responseType": "SUCCESS"}

Apply event page design operations

POST/events/{eventId}/page/operations

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:pages:mutate and events:pages:read · Requires an Idempotency-Key header

Applies typed relative operations to the current draft. Use a new operationId (and Idempotency-Key) for every request, preview or save: the platform replays the stored response for a repeated key and refuses the same key with a different body.

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedHeadRevision*number

Current head revision; zero for the first save

Range0 <= value <= 9007199254740991

operationId*string

Must equal the Idempotency-Key header

Lengthlength <= 256

mode*string

preview returns the resulting configuration and diff without changing page state; save performs a draft save

Value in

"preview"
"save"

operations*array<>

Operations applied in order to the current draft. Each takes exactly these keys: set_look_field(field, value); apply_look_preset(preset); set_pattern_field(field, value); apply_pattern_preset(preset); set_type_and_shapes_field(field, value); set_primary_color(value); set_second_color(value); set_section_visible(id, visible); set_section_settings(id, settings); move_section(id, before?, after?); add_section(type, before?, after?); remove_section(id); set_section_menu(value). Field values must satisfy the page-design contract.

Items1 <= items <= 32

Response Body

`application/json`

curl -X POST "https://example.com/events/string/page/operations" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedHeadRevision": 0,    "operationId": "string",    "mode": "preview",    "operations": [      {        "op": "set_look_field"      }    ]  }'

{  "success": true,  "data": {    "mode": "preview",    "eventId": "string",    "headRevision": 0,    "draftRevision": 1,    "publishedRevision": 1,    "config": {      "schemaVersion": 1,      "type": "event_page_design",      "catalogVersion": 1,      "look": {        "readyMadeLook": "defendr",        "layout": "classic",        "backdrop": "none",        "title": "solid",        "surface": "neutral",        "hideDefendrMenu": true,        "hideFooter": true,        "primaryColor": "strings"      },      "pattern": {        "designPattern": "clean",        "behindTheTop": "nothing",        "aroundTheTop": "nothing",        "titles": "bar",        "betweenSections": "nothing",        "cardsAndPictures": "plain",        "buttonsAndLabels": "plain"      },      "typeAndShapes": {        "headingTypeface": "default",        "textTypeface": "default",        "headings": "capitals",        "corners": "sharp",        "cards": "solid",        "buttons": "solid",        "secondColor": "strings"      },      "artwork": {},      "sections": {        "sectionMenu": true,        "items": []      }    },    "diff": [      {        "path": "string",        "before": null,        "after": null      }    ],    "issues": [      {        "path": "string",        "message": "string"      }    ]  },  "responseType": "SUCCESS"}

Preview event page without saving

POST/events/{eventId}/page/preview

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:pages:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Request Body

application/json

config*|

Response Body

`application/json`

curl -X POST "https://example.com/events/string/page/preview" \  -H "Content-Type: application/json" \  -d '{    "config": {      "schemaVersion": 1,      "type": "event_page_design",      "catalogVersion": 1,      "look": {        "readyMadeLook": "defendr",        "layout": "classic",        "backdrop": "none",        "title": "solid",        "surface": "neutral",        "hideDefendrMenu": true,        "hideFooter": true,        "primaryColor": "strings"      },      "pattern": {        "designPattern": "clean",        "behindTheTop": "nothing",        "aroundTheTop": "nothing",        "titles": "bar",        "betweenSections": "nothing",        "cardsAndPictures": "plain",        "buttonsAndLabels": "plain"      },      "typeAndShapes": {        "headingTypeface": "default",        "textTypeface": "default",        "headings": "capitals",        "corners": "sharp",        "cards": "solid",        "buttons": "solid",        "secondColor": "strings"      },      "artwork": {},      "sections": {        "sectionMenu": true,        "items": []      }    }  }'

{  "success": true,  "data": {    "preview": true,    "view": {      "event": {        "eventId": "string",        "name": "string",        "tagline": "string",        "description": "string",        "format": "online",        "location": "string",        "startAt": "2019-08-24T14:15:22Z",        "endAt": "2019-08-24T14:15:22Z",        "timezone": "string",        "phase": "upcoming",        "externalLinks": [          "http://example.com"        ]      },      "config": {        "schemaVersion": 1,        "type": "event_page_design",        "catalogVersion": 1,        "look": {          "readyMadeLook": "defendr",          "layout": "classic",          "backdrop": "none",          "title": "solid",          "surface": "neutral",          "hideDefendrMenu": true,          "hideFooter": true,          "primaryColor": "strings"        },        "pattern": {          "designPattern": "clean",          "behindTheTop": "nothing",          "aroundTheTop": "nothing",          "titles": "bar",          "betweenSections": "nothing",          "cardsAndPictures": "plain",          "buttonsAndLabels": "plain"        },        "typeAndShapes": {          "headingTypeface": "default",          "textTypeface": "default",          "headings": "capitals",          "corners": "sharp",          "cards": "solid",          "buttons": "solid",          "secondColor": "strings"        },        "artwork": {},        "sections": {          "sectionMenu": true,          "items": []        }      },      "media": {        "cover": {          "mediaId": "string",          "url": "http://example.com",          "contentType": "image/jpeg",          "contentLength": 1        },        "gallery": [          {            "mediaId": "string",            "url": "http://example.com",            "contentType": "image/jpeg",            "contentLength": 1          }        ]      },      "tournaments": {        "items": [          {            "tournamentId": "string",            "name": "string",            "slug": "string",            "startAt": "2019-08-24T14:15:22Z",            "endAt": "2019-08-24T14:15:22Z"          }        ],        "nextCursor": "string"      },      "sectionStates": {        "about": "ready",        "tournaments": "ready",        "gallery": "ready",        "when-and-where": "ready"      }    }  },  "responseType": "SUCCESS"}

Publish event page design

POST/events/{eventId}/page/publish

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:pages:publish · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedHeadRevision*number

Current head revision; zero for the first save

Range0 <= value <= 9007199254740991

operationId*string

Must equal the Idempotency-Key header

Lengthlength <= 256

targetRevision*number

Exact saved revision to publish

Range1 <= value <= 9007199254740991

Response Body

`application/json`

curl -X POST "https://example.com/events/string/page/publish" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedHeadRevision": 0,    "operationId": "string",    "targetRevision": 1  }'

{  "success": true,  "data": {    "eventId": "string",    "headRevision": 0,    "draftRevision": 1,    "publishedRevision": 1  },  "responseType": "SUCCESS"}

Reset event page design

POST/events/{eventId}/page/reset

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:pages:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedHeadRevision*number

Current head revision; zero for the first save

Range0 <= value <= 9007199254740991

operationId*string

Must equal the Idempotency-Key header

Lengthlength <= 256

Response Body

`application/json`

curl -X POST "https://example.com/events/string/page/reset" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedHeadRevision": 0,    "operationId": "string"  }'

{  "success": true,  "data": {    "eventId": "string",    "headRevision": 0,    "draftRevision": 1,    "publishedRevision": 1  },  "responseType": "SUCCESS"}

Restore event page design

POST/events/{eventId}/page/restore

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:pages:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedHeadRevision*number

Current head revision; zero for the first save

Range0 <= value <= 9007199254740991

operationId*string

Must equal the Idempotency-Key header

Lengthlength <= 256

sourceRevision*number

Saved revision to copy into a new draft

Range1 <= value <= 9007199254740991

Response Body

`application/json`

curl -X POST "https://example.com/events/string/page/restore" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedHeadRevision": 0,    "operationId": "string",    "sourceRevision": 1  }'

{  "success": true,  "data": {    "eventId": "string",    "headRevision": 0,    "draftRevision": 1,    "publishedRevision": 1  },  "responseType": "SUCCESS"}

Revision event page design

GET/events/{eventId}/page/revisions/{revision}

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:pages:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

revision*number

Response Body

`application/json`

curl -X GET "https://example.com/events/string/page/revisions/0"

{  "success": true,  "data": {    "revision": 1,    "createdAt": "2019-08-24T14:15:22Z",    "createdBy": "string",    "operation": "save",    "config": {      "schemaVersion": 1,      "type": "event_page_design",      "catalogVersion": 1,      "look": {        "readyMadeLook": "defendr",        "layout": "classic",        "backdrop": "none",        "title": "solid",        "surface": "neutral",        "hideDefendrMenu": true,        "hideFooter": true,        "primaryColor": "strings"      },      "pattern": {        "designPattern": "clean",        "behindTheTop": "nothing",        "aroundTheTop": "nothing",        "titles": "bar",        "betweenSections": "nothing",        "cardsAndPictures": "plain",        "buttonsAndLabels": "plain"      },      "typeAndShapes": {        "headingTypeface": "default",        "textTypeface": "default",        "headings": "capitals",        "corners": "sharp",        "cards": "solid",        "buttons": "solid",        "secondColor": "strings"      },      "artwork": {},      "sections": {        "sectionMenu": true,        "items": []      }    }  },  "responseType": "SUCCESS"}

History event page design

GET/events/{eventId}/page/revisions

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:pages:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/page/revisions"

{  "success": true,  "data": {    "items": [      {        "revision": 1,        "createdAt": "2019-08-24T14:15:22Z",        "createdBy": "string",        "operation": "save",        "schemaVersion": 0,        "catalogVersion": 0      }    ],    "nextCursor": 1  },  "responseType": "SUCCESS"}

Withdraw event page design

POST/events/{eventId}/page/withdraw

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:pages:publish · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedHeadRevision*number

Current head revision; zero for the first save

Range0 <= value <= 9007199254740991

operationId*string

Must equal the Idempotency-Key header

Lengthlength <= 256

Response Body

`application/json`

curl -X POST "https://example.com/events/string/page/withdraw" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedHeadRevision": 0,    "operationId": "string"  }'

{  "success": true,  "data": {    "eventId": "string",    "headRevision": 0,    "draftRevision": 1,    "publishedRevision": 1  },  "responseType": "SUCCESS"}

Read event page design

GET/events/{eventId}/page

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:pages:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/page"

{  "success": true,  "data": {    "eventId": "string",    "headRevision": 0,    "draftRevision": 1,    "publishedRevision": 1,    "config": {      "schemaVersion": 1,      "type": "event_page_design",      "catalogVersion": 1,      "look": {        "readyMadeLook": "defendr",        "layout": "classic",        "backdrop": "none",        "title": "solid",        "surface": "neutral",        "hideDefendrMenu": true,        "hideFooter": true,        "primaryColor": "strings"      },      "pattern": {        "designPattern": "clean",        "behindTheTop": "nothing",        "aroundTheTop": "nothing",        "titles": "bar",        "betweenSections": "nothing",        "cardsAndPictures": "plain",        "buttonsAndLabels": "plain"      },      "typeAndShapes": {        "headingTypeface": "default",        "textTypeface": "default",        "headings": "capitals",        "corners": "sharp",        "cards": "solid",        "buttons": "solid",        "secondColor": "strings"      },      "artwork": {},      "sections": {        "sectionMenu": true,        "items": []      }    }  },  "responseType": "SUCCESS"}

Publish event

POST/events/{eventId}/publish

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

revision*integer

Range1 <= value

Response Body

`application/json`

curl -X POST "https://example.com/events/string/publish" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "revision": 1  }'

Empty

Confirm event registration return

POST/events/{eventId}/registration-settings/complete

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:registrations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

state*string

Length43 <= length <= 43

registrationId*string

Length1 <= length <= 160

Response Body

`application/json`

curl -X POST "https://example.com/events/string/registration-settings/complete" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "state": "stringstringstringstringstringstringstrings",    "registrationId": "string"  }'

Empty

Read event registration settings

GET/events/{eventId}/registration-settings

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:registrations:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/registration-settings"

Empty

Configure event registration

PUT/events/{eventId}/registration-settings

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:registrations:mutate · Requires an Idempotency-Key header

Clerk callers must be organization administrators. API-key callers require the declared scopes; a Clerk organization role is not required for API keys.

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedRevision*integer

Range0 <= value

enabled*boolean

label*string

Length1 <= length <= 40

authEntryUrl*string

Formaturi

Lengthlength <= 2048

allowedReturnOrigins*array<>

Items1 <= items <= 10

Response Body

`application/json`

curl -X PUT "https://example.com/events/string/registration-settings" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedRevision": 0,    "enabled": true,    "label": "string",    "authEntryUrl": "http://example.com",    "allowedReturnOrigins": [      "http://example.com"    ]  }'

Empty

Continue event registration with private contact

POST/events/{eventId}/registrations/operations/{operationId}/contact

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:registrations:mutate and players:contact:mutate · Requires an Idempotency-Key header

Clerk callers must be organization administrators. API-key callers require the declared scopes; a Clerk organization role is not required for API keys.

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

operationId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

email*string

Formatemail

Lengthlength <= 254

contactRevision*integer

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/events/string/registrations/operations/string/contact" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "contactRevision": 0  }'

Empty

Retry event registration operation

POST/events/{eventId}/registrations/operations/{operationId}/retry

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:registrations:mutate · Requires an Idempotency-Key header

Clerk callers must be organization administrators. API-key callers require the declared scopes; a Clerk organization role is not required for API keys.

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

operationId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/events/string/registrations/operations/string/retry" \  -H "Idempotency-Key: string"

Empty

Read event registration operation

GET/events/{eventId}/registrations/operations/{operationId}

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:registrations:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

operationId*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/registrations/operations/string"

Empty

List event registrations

GET/events/{eventId}/registrations

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:registrations:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Query Parameters

cursor*string

limit*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/registrations?cursor=string&limit=string"

Empty

Register or cancel an event participant

POST/events/{eventId}/registrations

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:registrations:mutate · Requires an Idempotency-Key header

Clerk callers must be organization administrators. API-key callers require the declared scopes; a Clerk organization role is not required for API keys.

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

operationId*string

Length1 <= length <= 160

playerId?string

Length1 <= length <= 160

guestExternalId?string

Length1 <= length <= 200

displayName?string

Lengthlength <= 100

email?string

Formatemail

Lengthlength <= 254

contactRevision?integer

Range0 <= value

expectedRevision*integer

Range0 <= value

action*string

Value in

"register"
"cancel"

Response Body

`application/json`

curl -X POST "https://example.com/events/string/registrations" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "operationId": "string",    "expectedRevision": 0,    "action": "register"  }'

Empty

Submit Organizer event ticket admission

POST/events/{eventId}/tickets/admission

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:tickets:admit · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/events/string/tickets/admission" \  -H "Idempotency-Key: string"

Empty

Read Organizer event ticket authentication

GET/events/{eventId}/tickets/authentication

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:tickets:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/tickets/authentication"

Empty

Configure Organizer event ticket authentication

PUT/events/{eventId}/tickets/authentication

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:tickets:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/events/string/tickets/authentication" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read Organizer event ticket configuration

GET/events/{eventId}/tickets/configuration

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:tickets:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/tickets/configuration"

Empty

Configure Organizer event ticket configuration

PUT/events/{eventId}/tickets/configuration

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:tickets:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/events/string/tickets/configuration" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Submit Organizer event ticket orders by orderId retry

POST/events/{eventId}/tickets/orders/{orderId}/retry

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:tickets:mutate and messaging:replay · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

orderId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/events/string/tickets/orders/string/retry" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read Organizer event ticket orders

GET/events/{eventId}/tickets/orders

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:tickets:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Query Parameters

cursor*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/tickets/orders?cursor=string"

Empty

Read Organizer event ticket presentation

GET/events/{eventId}/tickets/presentation

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:tickets:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/tickets/presentation"

Empty

Configure Organizer event ticket presentation

PUT/events/{eventId}/tickets/presentation

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:tickets:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/events/string/tickets/presentation" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List Organizer event ticket designs

GET/events/{eventId}/tickets/templates

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:tickets:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Query Parameters

cursor*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/tickets/templates?cursor=string"

Empty

Save Organizer event ticket design

PUT/events/{eventId}/tickets/templates

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:tickets:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/events/string/tickets/templates" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Create tournament cleanup

POST/events/{eventId}/tournament-cleanup

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: messaging:replay and events:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/events/string/tournament-cleanup" \  -H "Idempotency-Key: string"

Empty

Change event tournament association

POST/events/{eventId}/tournaments/{tournamentId}

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:mutate and tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

tournamentId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/events/string/tournaments/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List event tournament associations

GET/events/{eventId}/tournaments

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:read and tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string/tournaments"

Empty

Create unpublish

POST/events/{eventId}/unpublish

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

revision*integer

Range1 <= value

Response Body

`application/json`

curl -X POST "https://example.com/events/string/unpublish" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "revision": 1  }'

Empty

Delete scheduled event

DELETE/events/{eventId}

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

revision*integer

Range1 <= value

Response Body

`application/json`

curl -X DELETE "https://example.com/events/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "revision": 1  }'

Empty

Read scheduled event

GET/events/{eventId}

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/events/string"

Empty

Update scheduled event

PATCH/events/{eventId}

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

if-match*string

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

name?string

Length1 <= length <= 160

tagline?string

Lengthlength <= 240

description?string

Lengthlength <= 10000

format?string

Value in

"online"
"lan"
"hybrid"

location?string

Lengthlength <= 500

startAt?string

Formatdate-time

endAt?string

Formatdate-time

timezone?string

Lengthlength <= 100

organizationId?string

Lengthlength <= 160

externalLinks?array<>

Response Body

`application/json`

curl -X PATCH "https://example.com/events/string" \  -H "if-match: string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List scheduled events

GET/events

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/events"

Empty

Create scheduled event

POST/events

API: Events · Base URL: $EVENT_API_URL · Authentication: API key · Required scope: events:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

name*string

Length1 <= length <= 160

tagline?string

Lengthlength <= 240

description?string

Lengthlength <= 10000

format?string

Value in

"online"
"lan"
"hybrid"

location?string

Lengthlength <= 500

startAt?string

Formatdate-time

endAt?string

Formatdate-time

timezone?string

Lengthlength <= 100

organizationId?string

Lengthlength <= 160

externalLinks?array<>

initialAdminPlayerId*string

A manually entered Player ID, assigned Event Admin atomically at creation. The ID may be stored before the Player exists; assignment does not create a Player account.

Length1 <= length <= 160

Response Body

`application/json`

curl -X POST "https://example.com/events" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "initialAdminPlayerId": "string"  }'

Empty

Replace resolution

PUT/fixtures/{fixtureId}/resolution

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: results:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

fixtureId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/fixtures/string/resolution" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read fixture

GET/fixtures/{fixtureId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: results:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

fixtureId*string

Response Body

`application/json`

curl -X GET "https://example.com/fixtures/string"

Empty

Delete free agent request

DELETE/free-agent-requests/{requestId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

requestId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/free-agent-requests/string" \  -H "Idempotency-Key: string"

Empty

Create free agent request

POST/free-agent-requests

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/free-agent-requests" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read game

GET/games/{gameId}

API: Game · Base URL: $GAME_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

gameId*string

Response Body

`application/json`

curl -X GET "https://example.com/games/string"

Empty

Find one game

GET/games/find/unique

API: Game · Base URL: $GAME_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Query Parameters

id?string

Game ID

name?string

Game Name

slug?string

Canonical game slug

requireGameTag?boolean

Whether the game requires a tag or not (unique identity)

company?string

Value in

"ARC SYSTEM WORKS"
"NINTENDO"
"SEGA"
"SONY INTERACTIVE ENTERTAINMENT"
"XBOX GAME STUDIOS"
"ELECTRONIC ARTS"
"ACTIVISION BLIZZARD"
"UBISOFT"
"EPIC GAMES"
"VALVE"
"RIOT GAMES"
"TAKE-TWO INTERACTIVE"
"ROCKSTAR GAMES"
"2K GAMES"
"BANDAI NAMCO"
"CAPCOM"
"KONAMI"
"SQUARE ENIX"
"FROMSOFTWARE"
"BETHESDA"
"CD PROJEKT RED"
"TENCENT GAMES"
"NETEASE GAMES"
"HOYOVERSE"
"KRAFTON"
"NEXON"
"NCSOFT"
"SMILEGATE"
"GARENA"
"SUPERCELL"
"BLIZZARD ENTERTAINMENT"
"BUNGIE"
"RESPAWN ENTERTAINMENT"
"INFINITY WARD"
"TREYARCH"
"SNK"
"KOEI TECMO"
"ATLUS"
"PLATINUMGAMES"
"KOJIMA PRODUCTIONS"
"SEGA SAMMY"
"WARNER BROS. GAMES"
"FOCUS ENTERTAINMENT"
"THQ NORDIC"
"PARADOX INTERACTIVE"
"DEVOLVER DIGITAL"
"ANNAPURNA INTERACTIVE"
"HELLO GAMES"
"MOJANG STUDIOS"
"ROBLOX CORPORATION"
"PSYONIX"
"OTHER"

requiredAccounts?array<>

platforms?array<>

Response Body

`application/json`

curl -X GET "https://example.com/games/find/unique"

Empty

List games

GET/games/find

API: Game · Base URL: $GAME_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Query Parameters

id?string

Game ID

name?string

Game Name

slug?string

Canonical game slug

requireGameTag?boolean

Whether the game requires a tag or not (unique identity)

company?string

Value in

"ARC SYSTEM WORKS"
"NINTENDO"
"SEGA"
"SONY INTERACTIVE ENTERTAINMENT"
"XBOX GAME STUDIOS"
"ELECTRONIC ARTS"
"ACTIVISION BLIZZARD"
"UBISOFT"
"EPIC GAMES"
"VALVE"
"RIOT GAMES"
"TAKE-TWO INTERACTIVE"
"ROCKSTAR GAMES"
"2K GAMES"
"BANDAI NAMCO"
"CAPCOM"
"KONAMI"
"SQUARE ENIX"
"FROMSOFTWARE"
"BETHESDA"
"CD PROJEKT RED"
"TENCENT GAMES"
"NETEASE GAMES"
"HOYOVERSE"
"KRAFTON"
"NEXON"
"NCSOFT"
"SMILEGATE"
"GARENA"
"SUPERCELL"
"BLIZZARD ENTERTAINMENT"
"BUNGIE"
"RESPAWN ENTERTAINMENT"
"INFINITY WARD"
"TREYARCH"
"SNK"
"KOEI TECMO"
"ATLUS"
"PLATINUMGAMES"
"KOJIMA PRODUCTIONS"
"SEGA SAMMY"
"WARNER BROS. GAMES"
"FOCUS ENTERTAINMENT"
"THQ NORDIC"
"PARADOX INTERACTIVE"
"DEVOLVER DIGITAL"
"ANNAPURNA INTERACTIVE"
"HELLO GAMES"
"MOJANG STUDIOS"
"ROBLOX CORPORATION"
"PSYONIX"
"OTHER"

requiredAccounts?array<>

platforms?array<>

page?number

Page Number

limit?number

Max Number of Records

Response Body

`application/json`

curl -X GET "https://example.com/games/find"

Empty

Convert between platform currencies

POST/internal-currency-exchange

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

playerId*string

from*string

Value in

"RED"
"BLUE"

to*string

Value in

"RED"
"BLUE"

amount*number

Amount to Exchange to Target Currency

gameId?string

Required for Blue Coins exchange

Response Body

`application/json`

curl -X POST "https://example.com/internal-currency-exchange" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "playerId": "string",    "from": "RED",    "to": "RED",    "amount": 0  }'

Empty

Read evidence media URL

GET/matches/{matchId}/evidence/{evidenceId}/media-url

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: results:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

evidenceId*string

Response Body

`application/json`

curl -X GET "https://example.com/matches/string/evidence/string/media-url"

Empty

Retry purge media

POST/matches/{matchId}/evidence/{evidenceId}/media/{mediaId}/retry-purge

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: results:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

evidenceId*string

mediaId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/matches/string/evidence/string/media/string/retry-purge" \  -H "Idempotency-Key: string"

Empty

Delete media

DELETE/matches/{matchId}/evidence/{evidenceId}/media/{mediaId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: results:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

evidenceId*string

mediaId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/matches/string/evidence/string/media/string" \  -H "Idempotency-Key: string"

Empty

Review evidence

POST/matches/{matchId}/evidence/{evidenceId}/review

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: results:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

evidenceId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/matches/string/evidence/string/review" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Complete media upload on evidence

POST/matches/{matchId}/evidence/{evidenceId}/uploads/{uploadId}/complete

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: participants:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

evidenceId*string

uploadId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/matches/string/evidence/string/uploads/string/complete" \  -H "Idempotency-Key: string"

Empty

Add media upload to evidence

POST/matches/{matchId}/evidence/{evidenceId}/uploads

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: participants:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

evidenceId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/matches/string/evidence/string/uploads" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Delete evidence

DELETE/matches/{matchId}/evidence/{evidenceId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: participants:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

evidenceId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/matches/string/evidence/string" \  -H "Idempotency-Key: string"

Empty

Read evidence item

GET/matches/{matchId}/evidence/{evidenceId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: results:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

evidenceId*string

Response Body

`application/json`

curl -X GET "https://example.com/matches/string/evidence/string"

Empty

Update evidence

PATCH/matches/{matchId}/evidence/{evidenceId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: participants:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

evidenceId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PATCH "https://example.com/matches/string/evidence/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Complete evidence media upload

POST/matches/{matchId}/evidence/uploads/{uploadId}/complete

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: participants:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

uploadId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/matches/string/evidence/uploads/string/complete" \  -H "Idempotency-Key: string"

Empty

Delete upload

DELETE/matches/{matchId}/evidence/uploads/{uploadId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: results:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

uploadId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/matches/string/evidence/uploads/string" \  -H "Idempotency-Key: string"

Empty

Start evidence media upload

POST/matches/{matchId}/evidence/uploads

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: participants:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/matches/string/evidence/uploads" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List match evidence

GET/matches/{matchId}/evidence

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: results:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

Response Body

`application/json`

curl -X GET "https://example.com/matches/string/evidence"

Empty

Create evidence

POST/matches/{matchId}/evidence

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: participants:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/matches/string/evidence" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Ready match

POST/matches/{matchId}/ready

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: participants:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/matches/string/ready" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List result revisions

GET/matches/{matchId}/result-revisions

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: results:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

Response Body

`application/json`

curl -X GET "https://example.com/matches/string/result-revisions"

Empty

Revert result

POST/matches/{matchId}/result/revert

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: results:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/matches/string/result/revert" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Replace result

PUT/matches/{matchId}/result

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: results:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/matches/string/result" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read match

GET/matches/{matchId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

Response Body

`application/json`

curl -X GET "https://example.com/matches/string"

Empty

Update match

PATCH/matches/{matchId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

matchId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PATCH "https://example.com/matches/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Disable organization

POST/organizations/{organizationId}/disable

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

organizationId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/organizations/string/disable" \  -H "Idempotency-Key: string"

Empty

Enable organization

POST/organizations/{organizationId}/enable

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

organizationId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/organizations/string/enable" \  -H "Idempotency-Key: string"

Empty

Delete organization

DELETE/organizations/{organizationId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

organizationId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/organizations/string" \  -H "Idempotency-Key: string"

Empty

Read organization

GET/organizations/{organizationId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

organizationId*string

Response Body

`application/json`

curl -X GET "https://example.com/organizations/string"

Empty

Update organization

PATCH/organizations/{organizationId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

organizationId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PATCH "https://example.com/organizations/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List organizations

GET/organizations

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/organizations"

Empty

Create organization

POST/organizations

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: organizations:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/organizations" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List limits

GET/plan/limits

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/plan/limits"

Empty

Search game stats for a player in a specific game

GET/player-game-stats/find/unique

API: Game · Base URL: $GAME_API_URL · Authentication: API key · Required scope: results:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Query Parameters

gameId?string

Game ID

playerId?string

Player ID

wins?number

Player Game Wins

losses?number

Player Game Losses

Response Body

`application/json`

curl -X GET "https://example.com/player-game-stats/find/unique"

Empty

Search game stats for a player

GET/player-game-stats/find

API: Game · Base URL: $GAME_API_URL · Authentication: API key · Required scope: results:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Query Parameters

gameId?string

Game ID

playerId?string

Player ID

wins?number

Player Game Wins

losses?number

Player Game Losses

page?number

Page Number

limit?number

Max Number of Records

Response Body

`application/json`

curl -X GET "https://example.com/player-game-stats/find"

Empty

Unequip one of your awards

DELETE/player/v1/awards/{awardId}/equip

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardId*string

Response Body

`application/json`

curl -X DELETE "https://example.com/player/v1/awards/string/equip"

Empty

Equip one of your awards

POST/player/v1/awards/{awardId}/equip

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardId*string

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/awards/string/equip"

Empty

List your awards

GET/player/v1/awards

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/awards"

Empty

Read event credential history as Player

GET/player/v1/events/{eventId}/badges/{issueId}/history

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

issueId*string

Query Parameters

historyCursor*string

deliveryCursor*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/badges/string/history?historyCursor=string&deliveryCursor=string"

Empty

Create event credential print link as Player

POST/player/v1/events/{eventId}/badges/{issueId}/print-link

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

issueId*string

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/badges/string/print-link"

Empty

Resend event credential email as Player

POST/player/v1/events/{eventId}/badges/{issueId}/resend

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

issueId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

operationId*string

Length1 <= length <= 160

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/badges/string/resend" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "operationId": "string"  }'

Empty

Revoke event credential as Player

POST/player/v1/events/{eventId}/badges/{issueId}/revoke

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

issueId*string

Request Body

application/json

revision*integer

Range1 <= value

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/badges/string/revoke" \  -H "Content-Type: application/json" \  -d '{    "revision": 1  }'

Empty

List event credential definitions as Player

GET/player/v1/events/{eventId}/badges/definitions

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Query Parameters

cursor*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/badges/definitions?cursor=string"

Empty

Save event credential definition as Player

PUT/player/v1/events/{eventId}/badges/definitions

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Request Body

application/json

definitionId*string

Length1 <= length <= 160

category*string

Length1 <= length <= 100

templateId*string

Length1 <= length <= 160

templateRevision*integer

Range1 <= value

expectedRevision*integer

Range0 <= value

enabled*boolean

validFrom?string

Formatdate-time

validUntil?string

Formatdate-time

Response Body

`application/json`

curl -X PUT "https://example.com/player/v1/events/string/badges/definitions" \  -H "Content-Type: application/json" \  -d '{    "definitionId": "string",    "category": "string",    "templateId": "string",    "templateRevision": 1,    "expectedRevision": 0,    "enabled": true  }'

Empty

Issue event credential as Player

POST/player/v1/events/{eventId}/badges/issues

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

definitionId*string

Length1 <= length <= 160

playerId*string

Length1 <= length <= 160

issuanceKey*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/badges/issues" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "definitionId": "string",    "playerId": "string",    "issuanceKey": "string"  }'

Empty

Retry event credential bulk job as Player

POST/player/v1/events/{eventId}/badges/jobs/{jobId}/retry

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

jobId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/badges/jobs/string/retry" \  -H "Idempotency-Key: string"

Empty

Read event credential bulk job as Player

GET/player/v1/events/{eventId}/badges/jobs/{jobId}

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

jobId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/badges/jobs/string"

Empty

Create event credential bulk job as Player

POST/player/v1/events/{eventId}/badges/jobs

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

definitionId*string

Length1 <= length <= 160

jobId*string

Length1 <= length <= 160

selector*string

Value in

"registered"
"crew"

role?string

Value in

"event_admin"
"event_manager"
"event_editor"
"media_manager"
"event_coordinator"

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/badges/jobs" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "definitionId": "string",    "jobId": "string",    "selector": "registered"  }'

Empty

Create own event credential print link as Player

POST/player/v1/events/{eventId}/badges/mine/{issueId}/print-link

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

issueId*string

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/badges/mine/string/print-link"

Empty

Read own event credentials as Player

GET/player/v1/events/{eventId}/badges/mine

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Query Parameters

cursor*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/badges/mine?cursor=string"

Empty

List event credential templates as Player

GET/player/v1/events/{eventId}/badges/templates

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Query Parameters

cursor*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/badges/templates?cursor=string"

Empty

Save event credential template as Player

PUT/player/v1/events/{eventId}/badges/templates

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Request Body

application/json

templateId*string

Length1 <= length <= 160

expectedRevision*integer

Range0 <= value

title*string

Length1 <= length <= 100

design*

At most 65536 UTF-8 bytes. Coordinates and dimensions are percentages; every element must fit inside the page. Image references must belong to this event.

archived*boolean

Response Body

`application/json`

curl -X PUT "https://example.com/player/v1/events/string/badges/templates" \  -H "Content-Type: application/json" \  -d '{    "templateId": "string",    "expectedRevision": 0,    "title": "string",    "design": {      "pageSize": "A4",      "orientation": "portrait",      "font": "inter",      "color": "string",      "background": "string",      "elements": [        {          "type": "text",          "x": 0,          "y": 0,          "width": 1,          "height": 1        }      ]    },    "archived": true  }'

Empty

Validate event credential as Player

POST/player/v1/events/{eventId}/badges/validate

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Request Body

application/json

handle*string

Length22 <= length <= 22

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/badges/validate" \  -H "Content-Type: application/json" \  -d '{    "handle": "stringstringstringstri"  }'

Empty

List event credentials as Player

GET/player/v1/events/{eventId}/badges

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Query Parameters

cursor*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/badges?cursor=string"

Empty

Search assigned event crew candidates

GET/player/v1/events/{eventId}/crew-candidates

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/crew-candidates"

Empty

Remove event crew as Player

DELETE/player/v1/events/{eventId}/crew/{playerId}

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

playerId*string

Request Body

application/json

eventRevision*integer

Range1 <= value

revision*integer

Range1 <= value

Response Body

`application/json`

curl -X DELETE "https://example.com/player/v1/events/string/crew/string" \  -H "Content-Type: application/json" \  -d '{    "eventRevision": 1,    "revision": 1  }'

Empty

Update event crew as Player

PATCH/player/v1/events/{eventId}/crew/{playerId}

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

playerId*string

Request Body

application/json

playerId*string

Length1 <= length <= 160

role*string

Value in

"event_admin"
"event_manager"
"event_editor"
"media_manager"
"event_coordinator"

eventRevision*integer

Range1 <= value

revision*integer

Range0 <= value

Response Body

`application/json`

curl -X PATCH "https://example.com/player/v1/events/string/crew/string" \  -H "Content-Type: application/json" \  -d '{    "playerId": "string",    "role": "event_admin",    "eventRevision": 1,    "revision": 0  }'

Empty

List assigned event crew

GET/player/v1/events/{eventId}/crew

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/crew"

Empty

Assign event crew as Player

POST/player/v1/events/{eventId}/crew

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Request Body

application/json

playerId*string

Length1 <= length <= 160

role*string

Value in

"event_admin"
"event_manager"
"event_editor"
"media_manager"
"event_coordinator"

eventRevision*integer

Range1 <= value

revision*integer

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/crew" \  -H "Content-Type: application/json" \  -d '{    "playerId": "string",    "role": "event_admin",    "eventRevision": 1,    "revision": 0  }'

Empty

Complete event media upload as Player

POST/player/v1/events/{eventId}/media/{kind}/uploads/{uploadId}/complete

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

kind*string

uploadId*string

Request Body

application/json

expectedMediaRevision*integer

Range0 <= value <= 9007199254740990

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/media/string/uploads/string/complete" \  -H "Content-Type: application/json" \  -d '{    "expectedMediaRevision": 0  }'

Empty

Start event media upload as Player

POST/player/v1/events/{eventId}/media/{kind}/uploads

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

kind*string

Request Body

application/json

Authorize a ten-minute staging upload. Completion verifies the bytes and promotes them to a distinct final public URL. Only the initiating principal on the same plane can complete it.

contentType*unknown

Value in

"image/jpeg"
"image/png"
"image/webp"

contentLength*integer

Range1 <= value <= 10485760

checksumSha256*string

Match^[a-fA-F0-9]{64}$

replaceMediaId?string

Match^med_[A-Za-z0-9_-]{1,128}$

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/media/string/uploads" \  -H "Content-Type: application/json" \  -d '{    "contentType": "image/jpeg",    "contentLength": 1,    "checksumSha256": "string"  }'

Empty

Remove event cover as Player

DELETE/player/v1/events/{eventId}/media/cover

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Request Body

application/json

expectedMediaRevision*integer

Range0 <= value <= 9007199254740990

Response Body

`application/json`

curl -X DELETE "https://example.com/player/v1/events/string/media/cover" \  -H "Content-Type: application/json" \  -d '{    "expectedMediaRevision": 0  }'

Empty

Remove event gallery photo as Player

DELETE/player/v1/events/{eventId}/media/gallery/{mediaId}

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

mediaId*string

Request Body

application/json

expectedMediaRevision*integer

Range0 <= value <= 9007199254740990

Response Body

`application/json`

curl -X DELETE "https://example.com/player/v1/events/string/media/gallery/string" \  -H "Content-Type: application/json" \  -d '{    "expectedMediaRevision": 0  }'

Empty

Reorder event gallery as Player

PUT/player/v1/events/{eventId}/media/gallery/order

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Request Body

application/json

expectedMediaRevision*integer

Range0 <= value <= 9007199254740990

mediaIds*array<string>

Itemsitems <= 12

Response Body

`application/json`

curl -X PUT "https://example.com/player/v1/events/string/media/gallery/order" \  -H "Content-Type: application/json" \  -d '{    "expectedMediaRevision": 0,    "mediaIds": [      "string"    ]  }'

Empty

Read event media as Player

GET/player/v1/events/{eventId}/media

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/media"

Empty

Save event page design as Player

PUT/player/v1/events/{eventId}/page/draft

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedHeadRevision*number

Current head revision; zero for the first save

Range0 <= value <= 9007199254740991

operationId*string

Must equal the Idempotency-Key header

Lengthlength <= 256

config*|

Response Body

`application/json`

curl -X PUT "https://example.com/player/v1/events/string/page/draft" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedHeadRevision": 0,    "operationId": "string",    "config": {      "schemaVersion": 1,      "type": "event_page_design",      "catalogVersion": 1,      "look": {        "readyMadeLook": "defendr",        "layout": "classic",        "backdrop": "none",        "title": "solid",        "surface": "neutral",        "hideDefendrMenu": true,        "hideFooter": true,        "primaryColor": "strings"      },      "pattern": {        "designPattern": "clean",        "behindTheTop": "nothing",        "aroundTheTop": "nothing",        "titles": "bar",        "betweenSections": "nothing",        "cardsAndPictures": "plain",        "buttonsAndLabels": "plain"      },      "typeAndShapes": {        "headingTypeface": "default",        "textTypeface": "default",        "headings": "capitals",        "corners": "sharp",        "cards": "solid",        "buttons": "solid",        "secondColor": "strings"      },      "artwork": {},      "sections": {        "sectionMenu": true,        "items": []      }    }  }'

{  "success": true,  "data": {    "eventId": "string",    "headRevision": 0,    "draftRevision": 1,    "publishedRevision": 1  },  "responseType": "SUCCESS"}

Publish event page design as Player

POST/player/v1/events/{eventId}/page/publish

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedHeadRevision*number

Current head revision; zero for the first save

Range0 <= value <= 9007199254740991

operationId*string

Must equal the Idempotency-Key header

Lengthlength <= 256

targetRevision*number

Exact saved revision to publish

Range1 <= value <= 9007199254740991

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/page/publish" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedHeadRevision": 0,    "operationId": "string",    "targetRevision": 1  }'

{  "success": true,  "data": {    "eventId": "string",    "headRevision": 0,    "draftRevision": 1,    "publishedRevision": 1  },  "responseType": "SUCCESS"}

Reset event page design as Player

POST/player/v1/events/{eventId}/page/reset

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedHeadRevision*number

Current head revision; zero for the first save

Range0 <= value <= 9007199254740991

operationId*string

Must equal the Idempotency-Key header

Lengthlength <= 256

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/page/reset" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedHeadRevision": 0,    "operationId": "string"  }'

{  "success": true,  "data": {    "eventId": "string",    "headRevision": 0,    "draftRevision": 1,    "publishedRevision": 1  },  "responseType": "SUCCESS"}

Restore event page design as Player

POST/player/v1/events/{eventId}/page/restore

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedHeadRevision*number

Current head revision; zero for the first save

Range0 <= value <= 9007199254740991

operationId*string

Must equal the Idempotency-Key header

Lengthlength <= 256

sourceRevision*number

Saved revision to copy into a new draft

Range1 <= value <= 9007199254740991

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/page/restore" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedHeadRevision": 0,    "operationId": "string",    "sourceRevision": 1  }'

{  "success": true,  "data": {    "eventId": "string",    "headRevision": 0,    "draftRevision": 1,    "publishedRevision": 1  },  "responseType": "SUCCESS"}

Revision event page design as Player

GET/player/v1/events/{eventId}/page/revisions/{revision}

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

revision*number

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/page/revisions/0"

{  "success": true,  "data": {    "revision": 1,    "createdAt": "2019-08-24T14:15:22Z",    "createdBy": "string",    "operation": "save",    "config": {      "schemaVersion": 1,      "type": "event_page_design",      "catalogVersion": 1,      "look": {        "readyMadeLook": "defendr",        "layout": "classic",        "backdrop": "none",        "title": "solid",        "surface": "neutral",        "hideDefendrMenu": true,        "hideFooter": true,        "primaryColor": "strings"      },      "pattern": {        "designPattern": "clean",        "behindTheTop": "nothing",        "aroundTheTop": "nothing",        "titles": "bar",        "betweenSections": "nothing",        "cardsAndPictures": "plain",        "buttonsAndLabels": "plain"      },      "typeAndShapes": {        "headingTypeface": "default",        "textTypeface": "default",        "headings": "capitals",        "corners": "sharp",        "cards": "solid",        "buttons": "solid",        "secondColor": "strings"      },      "artwork": {},      "sections": {        "sectionMenu": true,        "items": []      }    }  },  "responseType": "SUCCESS"}

History event page design as Player

GET/player/v1/events/{eventId}/page/revisions

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/page/revisions"

{  "success": true,  "data": {    "items": [      {        "revision": 1,        "createdAt": "2019-08-24T14:15:22Z",        "createdBy": "string",        "operation": "save",        "schemaVersion": 0,        "catalogVersion": 0      }    ],    "nextCursor": 1  },  "responseType": "SUCCESS"}

Withdraw event page design as Player

POST/player/v1/events/{eventId}/page/withdraw

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

expectedHeadRevision*number

Current head revision; zero for the first save

Range0 <= value <= 9007199254740991

operationId*string

Must equal the Idempotency-Key header

Lengthlength <= 256

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/page/withdraw" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expectedHeadRevision": 0,    "operationId": "string"  }'

{  "success": true,  "data": {    "eventId": "string",    "headRevision": 0,    "draftRevision": 1,    "publishedRevision": 1  },  "responseType": "SUCCESS"}

Read event page design as Player

GET/player/v1/events/{eventId}/page

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/page"

{  "success": true,  "data": {    "eventId": "string",    "headRevision": 0,    "draftRevision": 1,    "publishedRevision": 1,    "config": {      "schemaVersion": 1,      "type": "event_page_design",      "catalogVersion": 1,      "look": {        "readyMadeLook": "defendr",        "layout": "classic",        "backdrop": "none",        "title": "solid",        "surface": "neutral",        "hideDefendrMenu": true,        "hideFooter": true,        "primaryColor": "strings"      },      "pattern": {        "designPattern": "clean",        "behindTheTop": "nothing",        "aroundTheTop": "nothing",        "titles": "bar",        "betweenSections": "nothing",        "cardsAndPictures": "plain",        "buttonsAndLabels": "plain"      },      "typeAndShapes": {        "headingTypeface": "default",        "textTypeface": "default",        "headings": "capitals",        "corners": "sharp",        "cards": "solid",        "buttons": "solid",        "secondColor": "strings"      },      "artwork": {},      "sections": {        "sectionMenu": true,        "items": []      }    }  },  "responseType": "SUCCESS"}

Publish assigned event

POST/player/v1/events/{eventId}/publish

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Request Body

application/json

revision*integer

Range1 <= value

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/publish" \  -H "Content-Type: application/json" \  -d '{    "revision": 1  }'

Empty

Read registration presentation as Player

GET/player/v1/events/{eventId}/registration-presentation

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/registration-presentation"

Empty

Edit registration presentation as Player

POST/player/v1/events/{eventId}/registration-presentation

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Request Body

application/json

expectedRevision*integer

Range0 <= value

label*string

Length1 <= length <= 40

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/registration-presentation" \  -H "Content-Type: application/json" \  -d '{    "expectedRevision": 0,    "label": "string"  }'

Empty

Read own event registration as Player

GET/player/v1/events/{eventId}/registration

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/registration"

Empty

Change own event registration as Player

POST/player/v1/events/{eventId}/registration

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

operationId*string

Length1 <= length <= 160

playerId?string

Length1 <= length <= 160

guestExternalId?string

Length1 <= length <= 200

displayName?string

Lengthlength <= 100

email?string

Formatemail

Lengthlength <= 254

contactRevision?integer

Range0 <= value

expectedRevision*integer

Range0 <= value

action*string

Value in

"register"
"cancel"

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/registration" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "operationId": "string",    "expectedRevision": 0,    "action": "register"  }'

Empty

Retry event registration operation as Player

POST/player/v1/events/{eventId}/registrations/operations/{operationId}/retry

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

operationId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/registrations/operations/string/retry" \  -H "Idempotency-Key: string"

Empty

Read event registration operation as Player

GET/player/v1/events/{eventId}/registrations/operations/{operationId}

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

operationId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/registrations/operations/string"

Empty

List event registrations as Player

GET/player/v1/events/{eventId}/registrations

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Query Parameters

cursor*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/registrations?cursor=string"

Empty

Register or cancel an event participant as Player

POST/player/v1/events/{eventId}/registrations

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

operationId*string

Length1 <= length <= 160

playerId?string

Length1 <= length <= 160

guestExternalId?string

Length1 <= length <= 200

displayName?string

Lengthlength <= 100

email?string

Formatemail

Lengthlength <= 254

contactRevision?integer

Range0 <= value

expectedRevision*integer

Range0 <= value

action*string

Value in

"register"
"cancel"

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/registrations" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "operationId": "string",    "expectedRevision": 0,    "action": "register"  }'

Empty

Submit Player event ticket admission

POST/player/v1/events/{eventId}/tickets/admission

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/tickets/admission" \  -H "Idempotency-Key: string"

Empty

Submit Player event ticket checkout complete

POST/player/v1/events/{eventId}/tickets/checkout/complete

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/tickets/checkout/complete"

Empty

Configure Player event ticket configuration

PUT/player/v1/events/{eventId}/tickets/configuration

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/player/v1/events/string/tickets/configuration" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read Player event ticket offers

GET/player/v1/events/{eventId}/tickets/offers

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/tickets/offers"

Empty

Read Player event ticket orders by orderId deliveries

GET/player/v1/events/{eventId}/tickets/orders/{orderId}/deliveries

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

orderId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/tickets/orders/string/deliveries"

Empty

Submit Player event ticket orders by orderId deliveries

POST/player/v1/events/{eventId}/tickets/orders/{orderId}/deliveries

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

orderId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/tickets/orders/string/deliveries" \  -H "Idempotency-Key: string"

Empty

Read Player event ticket orders by orderId print link

GET/player/v1/events/{eventId}/tickets/orders/{orderId}/print-link

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

orderId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/tickets/orders/string/print-link"

Empty

Read Player event ticket orders by orderId

GET/player/v1/events/{eventId}/tickets/orders/{orderId}

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

orderId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/tickets/orders/string"

Empty

Read Player event ticket orders operations by operationId

GET/player/v1/events/{eventId}/tickets/orders/operations/{operationId}

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

operationId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/tickets/orders/operations/string"

Empty

Read Player event ticket orders

GET/player/v1/events/{eventId}/tickets/orders

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Query Parameters

cursor*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/tickets/orders?cursor=string"

Empty

Submit Player event ticket orders

POST/player/v1/events/{eventId}/tickets/orders

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/tickets/orders" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read Player event ticket presentation

GET/player/v1/events/{eventId}/tickets/presentation

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/tickets/presentation"

Empty

Configure Player event ticket presentation

PUT/player/v1/events/{eventId}/tickets/presentation

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/player/v1/events/string/tickets/presentation" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read Player event ticket sales

GET/player/v1/events/{eventId}/tickets/sales

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Query Parameters

cursor*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/tickets/sales?cursor=string"

Empty

List Player event ticket designs

GET/player/v1/events/{eventId}/tickets/templates

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Query Parameters

cursor*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string/tickets/templates?cursor=string"

Empty

Save Player event ticket design

PUT/player/v1/events/{eventId}/tickets/templates

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/player/v1/events/string/tickets/templates" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Unpublish assigned event

POST/player/v1/events/{eventId}/unpublish

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Request Body

application/json

revision*integer

Range1 <= value

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/events/string/unpublish" \  -H "Content-Type: application/json" \  -d '{    "revision": 1  }'

Empty

Delete assigned event

DELETE/player/v1/events/{eventId}

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Request Body

application/json

revision*integer

Range1 <= value

Response Body

`application/json`

curl -X DELETE "https://example.com/player/v1/events/string" \  -H "Content-Type: application/json" \  -d '{    "revision": 1  }'

Empty

Read assigned event

GET/player/v1/events/{eventId}

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/events/string"

Empty

Update assigned event

PATCH/player/v1/events/{eventId}

API: Events · Base URL: $EVENT_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventId*string

Header Parameters

if-match*string

Request Body

application/json

name?string

Length1 <= length <= 160

tagline?string

Lengthlength <= 240

description?string

Lengthlength <= 10000

format?string

Value in

"online"
"lan"
"hybrid"

location?string

Lengthlength <= 500

startAt?string

Formatdate-time

endAt?string

Formatdate-time

timezone?string

Lengthlength <= 100

organizationId?string

Lengthlength <= 160

externalLinks?array<>

Response Body

`application/json`

curl -X PATCH "https://example.com/player/v1/events/string" \  -H "if-match: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Confirm one of your exchanges

POST/player/v1/exchanges/{exchangeId}/confirm

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

exchangeId*string

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/exchanges/string/confirm" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Release one of your held exchanges

POST/player/v1/exchanges/{exchangeId}/release

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

exchangeId*string

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/exchanges/string/release"

Empty

Read one of your exchanges

GET/player/v1/exchanges/{exchangeId}

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

exchangeId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/exchanges/string"

Empty

Quote an exchange for yourself

GET/player/v1/exchanges/quote

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/exchanges/quote"

Empty

List your exchanges

GET/player/v1/exchanges

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/exchanges"

Empty

Start an exchange

POST/player/v1/exchanges

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/exchanges" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Claim your daily activity

POST/player/v1/gamification/activity

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/gamification/activity"

Empty

Claim a battle-pass tier

POST/player/v1/gamification/battle-pass/claims

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/gamification/battle-pass/claims" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read your battle pass

GET/player/v1/gamification/battle-pass

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/gamification/battle-pass"

Empty

Open one of your chests

POST/player/v1/gamification/chests/{inventoryId}/open

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

inventoryId*string

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/gamification/chests/string/open"

Empty

List your opened chests

GET/player/v1/gamification/chests/history

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/gamification/chests/history"

Empty

Read your chest pity counters

GET/player/v1/gamification/chests/pity

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/gamification/chests/pity"

Empty

List your unopened chests

GET/player/v1/gamification/chests

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/gamification/chests"

Empty

Read a leaderboard

GET/player/v1/gamification/leaderboards/{period}/{entityType}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

period*string

entityType*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/gamification/leaderboards/string/string"

Empty

List the missions available to you

GET/player/v1/gamification/missions

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/gamification/missions"

Empty

Read your progression

GET/player/v1/gamification/progress

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/gamification/progress"

Empty

Read membership

GET/player/v1/membership

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/membership"

Empty

Mark one of your notifications read

PATCH/player/v1/notifications/{notificationId}/read

API: Notification · Base URL: $NOTIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

notificationId*string

Response Body

`application/json`

curl -X PATCH "https://example.com/player/v1/notifications/string/read"

Empty

Mark all your notifications read

PATCH/player/v1/notifications/read

API: Notification · Base URL: $NOTIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X PATCH "https://example.com/player/v1/notifications/read"

Empty

List your notifications

GET/player/v1/notifications

API: Notification · Base URL: $NOTIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/notifications"

Empty

List your prize payouts

GET/player/v1/payouts

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/payouts"

Empty

Read your own Player profile

GET/player/v1/profile

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/profile"

{  "playerId": "string",  "nickname": "string",  "isDefaultNickname": true}

Start an eligible timed attempt

POST/player/v1/quizzes/{quizId}/attempts

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

quizId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/quizzes/string/attempts" \  -H "Idempotency-Key: string"

Empty

Read a Quiz cover

GET/player/v1/quizzes/{quizId}/cover

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

quizId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/quizzes/string/cover"

Empty

Read Quiz rules and rewards

GET/player/v1/quizzes/{quizId}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

quizId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/quizzes/string"

Empty

Submit the current question answer

POST/player/v1/quizzes/attempts/{attemptId}/answers

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

attemptId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

questionId*string

Match^[A-Za-z0-9_-]{1,100}$

answerIds*array<>

Items0 <= items <= 20

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/quizzes/attempts/string/answers" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "questionId": "string",    "answerIds": []  }'

Empty

Resume your current question or read your result

GET/player/v1/quizzes/attempts/{attemptId}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

attemptId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/quizzes/attempts/string"

Empty

Read your Quiz participation history

GET/player/v1/quizzes/history

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Query Parameters

cursor*string

limit*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/quizzes/history?cursor=string&limit=string"

Empty

Discover available quizzes

GET/player/v1/quizzes

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Query Parameters

cursor*string

limit*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/quizzes?cursor=string&limit=string"

Empty

Read redemption

GET/player/v1/redeemable-keys/redemptions/{redemptionId}

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

redemptionId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/redeemable-keys/redemptions/string"

Empty

List redemptions

GET/player/v1/redeemable-keys/redemptions

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/redeemable-keys/redemptions"

Empty

Create redemption

POST/player/v1/redeemable-keys/redemptions

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/redeemable-keys/redemptions" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List your settled reward grants

GET/player/v1/reward-grants

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/reward-grants"

Empty

Search your own records

GET/player/v1/search

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/search"

Empty

Create session

POST/player/v1/sessions

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: Player-session credential, from your backend only (no browser CORS)

Authorization

playerSessionCredential

AuthorizationBearer <token>

In: header

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/sessions" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Remove a line from your Shop cart

DELETE/player/v1/shop/cart/lines/{listingKey}

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

listingKey*string

Response Body

`application/json`

curl -X DELETE "https://example.com/player/v1/shop/cart/lines/string"

Empty

Set a line in your Shop cart

PUT/player/v1/shop/cart/lines/{listingKey}

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

listingKey*string

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/player/v1/shop/cart/lines/string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Empty your Shop cart

DELETE/player/v1/shop/cart

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X DELETE "https://example.com/player/v1/shop/cart"

Empty

Read your Shop cart

GET/player/v1/shop/cart

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/shop/cart"

Empty

Check out your Shop cart

POST/player/v1/shop/checkout

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/shop/checkout" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read one Shop listing

GET/player/v1/shop/listings/{listingKey}

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

listingKey*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/shop/listings/string"

Empty

List the Shop listings available to you

GET/player/v1/shop/listings

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/shop/listings"

Empty

Cancel one of your Shop orders

POST/player/v1/shop/orders/{orderId}/cancel

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

orderId*string

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/shop/orders/string/cancel"

Empty

Reveal the codes of one of your Shop orders

POST/player/v1/shop/orders/{orderId}/codes

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

orderId*string

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/shop/orders/string/codes"

Empty

Read one of your Shop orders

GET/player/v1/shop/orders/{orderId}

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Path Parameters

orderId*string

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/shop/orders/string"

Empty

List your Shop orders

GET/player/v1/shop/orders

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/shop/orders"

Empty

Buy one Shop listing directly

POST/player/v1/shop/purchases

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token · Requires an Idempotency-Key header

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/player/v1/shop/purchases" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List your wallets

GET/player/v1/wallets

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/wallets"

Empty

Read the Web3 capabilities available to you

GET/player/v1/web3/capabilities

API: Reward · Base URL: $REWARD_API_URL · Authentication: Player bearer token

Authorization

playerBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/player/v1/web3/capabilities"

Empty

Delete stage

DELETE/stages/{stageId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

stageId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/stages/string" \  -H "Idempotency-Key: string"

Empty

Read stage

GET/stages/{stageId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

stageId*string

Response Body

`application/json`

curl -X GET "https://example.com/stages/string"

Empty

Update stage

PATCH/stages/{stageId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

stageId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PATCH "https://example.com/stages/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Delete member

DELETE/teams/{teamId}/members/{memberId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

teamId*string

memberId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/teams/string/members/string" \  -H "Idempotency-Key: string"

Empty

Update member

PATCH/teams/{teamId}/members/{memberId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

teamId*string

memberId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PATCH "https://example.com/teams/string/members/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Create member

POST/teams/{teamId}/members

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

teamId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/teams/string/members" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Delete role

DELETE/teams/{teamId}/roles/{roleKey}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

teamId*string

roleKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/teams/string/roles/string" \  -H "Idempotency-Key: string"

Empty

Create role

POST/teams/{teamId}/roles

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

teamId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/teams/string/roles" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Delete team

DELETE/teams/{teamId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

teamId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/teams/string" \  -H "Idempotency-Key: string"

Empty

Read team

GET/teams/{teamId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

teamId*string

Response Body

`application/json`

curl -X GET "https://example.com/teams/string"

Empty

Update team

PATCH/teams/{teamId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

teamId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PATCH "https://example.com/teams/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List teams

GET/teams

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Query Parameters

esportsOrganizationId*string

Response Body

`application/json`

curl -X GET "https://example.com/teams?esportsOrganizationId=string"

Empty

Create team

POST/teams

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/teams" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List tournament configuration templates

GET/tournament-configuration-templates

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/tournament-configuration-templates"

Empty

Cancel tournament

POST/tournaments/{slug}/cancel

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/tournaments/string/cancel" \  -H "Idempotency-Key: string"

Empty

Close check in

POST/tournaments/{slug}/check-in/close

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/tournaments/string/check-in/close" \  -H "Idempotency-Key: string"

Empty

Complete tournament

POST/tournaments/{slug}/complete

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/tournaments/string/complete" \  -H "Idempotency-Key: string"

Empty

List entrants

GET/tournaments/{slug}/entrants

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Response Body

`application/json`

curl -X GET "https://example.com/tournaments/string/entrants"

Empty

List matches

GET/tournaments/{slug}/matches

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Response Body

`application/json`

curl -X GET "https://example.com/tournaments/string/matches"

Empty

Create participant swap

POST/tournaments/{slug}/participant-swaps

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/tournaments/string/participant-swaps" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read public tournament view

GET/tournaments/{slug}/public

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Response Body

`application/json`

curl -X GET "https://example.com/tournaments/string/public"

Empty

Publish tournament

POST/tournaments/{slug}/publish

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Header Parameters

if-match?string

Optional. The tournament revision the caller last read (3, "3" or W/"3"). A stale revision is refused with 409 TOURNAMENT_REVISION_CONFLICT and nothing is written; a malformed value is refused with 400 TOURNAMENT_REVISION_INVALID.

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/tournaments/string/publish" \  -H "Idempotency-Key: string"

Empty

Close registration

POST/tournaments/{slug}/registration/close

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/tournaments/string/registration/close" \  -H "Idempotency-Key: string"

Empty

Reopen registration

POST/tournaments/{slug}/registration/reopen

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/tournaments/string/registration/reopen" \  -H "Idempotency-Key: string"

Empty

Read stage composition

GET/tournaments/{slug}/stage-compositions/{compositionId}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

compositionId*string

Response Body

`application/json`

curl -X GET "https://example.com/tournaments/string/stage-compositions/string"

Empty

Preview stage composition

POST/tournaments/{slug}/stage-compositions/preview

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/tournaments/string/stage-compositions/preview" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List stage compositions

GET/tournaments/{slug}/stage-compositions

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Response Body

`application/json`

curl -X GET "https://example.com/tournaments/string/stage-compositions"

Empty

Create stage composition

POST/tournaments/{slug}/stage-compositions

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/tournaments/string/stage-compositions" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Create generate batch

POST/tournaments/{slug}/stages/generate-batch

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/tournaments/string/stages/generate-batch" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Generate stage

POST/tournaments/{slug}/stages/generate

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/tournaments/string/stages/generate" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Preview stage

POST/tournaments/{slug}/stages/preview

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/tournaments/string/stages/preview" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List stages

GET/tournaments/{slug}/stages

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Response Body

`application/json`

curl -X GET "https://example.com/tournaments/string/stages"

Empty

List standings

GET/tournaments/{slug}/standings

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: results:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Response Body

`application/json`

curl -X GET "https://example.com/tournaments/string/standings"

Empty

Start tournament

POST/tournaments/{slug}/start

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/tournaments/string/start" \  -H "Idempotency-Key: string"

Empty

Delete tournament

DELETE/tournaments/{slug}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X DELETE "https://example.com/tournaments/string" \  -H "Idempotency-Key: string"

Empty

Read tournament

GET/tournaments/{slug}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Response Body

`application/json`

curl -X GET "https://example.com/tournaments/string"

Empty

Update tournament

PATCH/tournaments/{slug}

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

slug*string

Header Parameters

if-match?string

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PATCH "https://example.com/tournaments/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List tournaments

GET/tournaments

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/tournaments"

Empty

Create tournament

POST/tournaments

API: Tournament · Base URL: $TOURNAMENT_API_URL · Authentication: API key · Required scope: tournaments:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

organizationId*string

name*string

Length1 <= length <= 120

configurationMode*string

Value in

"express"
"standard"
"advanced"

visibility*string

Value in

"public"
"private"

participantMode*string

Value in

"solo"
"team"

identityModes*array<>

Items1 <= items

capacity*

registration*

schedule*

lifecyclePolicy*

Response Body

`application/json`

curl -X POST "https://example.com/tournaments" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "organizationId": "string",    "name": "string",    "configurationMode": "express",    "visibility": "public",    "participantMode": "solo",    "identityModes": [      "saas"    ],    "capacity": {      "minEntrants": 2    },    "registration": {      "opensAt": "2019-08-24T14:15:22Z",      "closesAt": "2019-08-24T14:15:22Z"    },    "schedule": {      "startsAt": "2019-08-24T14:15:22Z"    },    "lifecyclePolicy": {}  }'

Empty

List audits

GET/v1/audits

API: Tenant · Base URL: $TENANT_API_URL · Authentication: API key · Required scope: audit:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/audits"

{  "items": [    {      "auditId": "string",      "actorNamespace": "account_auth_admin",      "actorId": "string",      "action": "string",      "resourceType": "string",      "resourceId": "string",      "title": "string",      "summary": "string",      "requestType": "Create",      "requestDescription": "string",      "actorLabel": "string",      "resourceLabel": "string",      "changes": [        {          "field": "string",          "label": "string",          "before": "string",          "after": "string"        }      ],      "requestBody": {},      "requestBodyOmitted": "string",      "requestBodyBytes": 0,      "outcome": "allowed",      "errorCode": "string",      "scope": "string",      "requestId": "string",      "agent": {        "agentKey": "string",        "agentVersion": "string",        "runId": "string",        "toolCallId": "string"      },      "occurredAt": "string"    }  ],  "nextCursor": "string"}

Archive award kind

POST/v1/award-kinds/{awardKindKey}/archive

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardKindKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/award-kinds/string/archive" \  -H "Idempotency-Key: string"

Empty

Publish award kind

POST/v1/award-kinds/{awardKindKey}/publish

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardKindKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/award-kinds/string/publish" \  -H "Idempotency-Key: string"

Empty

Update award kind

PATCH/v1/award-kinds/{awardKindKey}

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardKindKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/award-kinds/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List award kinds

GET/v1/award-kinds

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/award-kinds"

Empty

Create award kind

POST/v1/award-kinds

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/award-kinds" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List fulfillments

GET/v1/awards/{awardId}/fulfillments

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/awards/string/fulfillments"

Empty

Request award fulfillment

POST/v1/awards/{awardId}/fulfillments

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/awards/string/fulfillments" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List mint records

GET/v1/awards/{awardId}/mint-records

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/awards/string/mint-records"

Empty

Create mint record

POST/v1/awards/{awardId}/mint-records

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/awards/string/mint-records" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List payouts for award

GET/v1/awards/{awardId}/payouts

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/awards/string/payouts"

Empty

Create payout

POST/v1/awards/{awardId}/payouts

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/awards/string/payouts" \  -H "Idempotency-Key: string"

Empty

Resolve award recipient

POST/v1/awards/{awardId}/recipient

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/awards/string/recipient" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read award

GET/v1/awards/{awardId}

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/awards/string"

Empty

Publish definition

POST/v1/awards/definitions/{awardKey}/publish

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/awards/definitions/string/publish" \  -H "Idempotency-Key: string"

Empty

Retire definition

POST/v1/awards/definitions/{awardKey}/retire

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/awards/definitions/string/retire" \  -H "Idempotency-Key: string"

Empty

Read definition

GET/v1/awards/definitions/{awardKey}

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardKey*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/awards/definitions/string"

Empty

Update definition

PATCH/v1/awards/definitions/{awardKey}

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

awardKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/awards/definitions/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List definitions

GET/v1/awards/definitions

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/awards/definitions"

Empty

Create definition

POST/v1/awards/definitions

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/awards/definitions" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Grant award

POST/v1/awards/grants

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/awards/grants" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Settle tournament

POST/v1/awards/tournaments/{tournamentId}/settle

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

tournamentId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/awards/tournaments/string/settle" \  -H "Idempotency-Key: string"

Empty

Read trigger policy

GET/v1/awards/trigger-policy

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/awards/trigger-policy"

Empty

List awards

GET/v1/awards

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/awards"

Empty

Archive currency

POST/v1/currencies/{currencyKey}/archive

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

currencyKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/currencies/string/archive" \  -H "Idempotency-Key: string"

Empty

Publish currency

POST/v1/currencies/{currencyKey}/publish

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

currencyKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/currencies/string/publish" \  -H "Idempotency-Key: string"

Empty

List currencies

GET/v1/currencies

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/currencies"

Empty

Create currency

POST/v1/currencies

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/currencies" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List event players

GET/v1/event-players

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: API key · Required scope: participants:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/event-players"

Empty

Reconcile exchange

POST/v1/exchanges/{exchangeId}/reconcile

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

exchangeId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/exchanges/string/reconcile" \  -H "Idempotency-Key: string"

Empty

Release exchange

POST/v1/exchanges/{exchangeId}/release

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

exchangeId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/exchanges/string/release" \  -H "Idempotency-Key: string"

Empty

Read exchange

GET/v1/exchanges/{exchangeId}

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

exchangeId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/exchanges/string"

Empty

List exchanges

GET/v1/exchanges

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/exchanges"

Empty

Activate season

POST/v1/gamification/battle-pass/seasons/{seasonKey}/activate

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

seasonKey*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/gamification/battle-pass/seasons/string/activate"

Empty

Update season

PATCH/v1/gamification/battle-pass/seasons/{seasonKey}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

seasonKey*string

Request Body

application/json

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/gamification/battle-pass/seasons/string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List seasons

GET/v1/gamification/battle-pass/seasons

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/gamification/battle-pass/seasons"

Empty

Create season

POST/v1/gamification/battle-pass/seasons

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/gamification/battle-pass/seasons" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Approve catalogue mission

POST/v1/gamification/catalog/approvals

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:approve

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/gamification/catalog/approvals" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Disable mission

POST/v1/gamification/catalog/missions/{missionKey}/disable

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

missionKey*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/gamification/catalog/missions/string/disable"

Empty

Read mission

GET/v1/gamification/catalog/missions/{missionKey}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

missionKey*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/gamification/catalog/missions/string"

Empty

Update mission

PATCH/v1/gamification/catalog/missions/{missionKey}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

missionKey*string

Request Body

application/json

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/gamification/catalog/missions/string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List missions

GET/v1/gamification/catalog/missions

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/gamification/catalog/missions"

Empty

Create mission

POST/v1/gamification/catalog/missions

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/gamification/catalog/missions" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read chest economy revision

GET/v1/gamification/chests/economy/{revision}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

revision*number

Response Body

`application/json`

curl -X GET "https://example.com/v1/gamification/chests/economy/0"

Empty

Read chest economy

GET/v1/gamification/chests/economy

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/gamification/chests/economy"

Empty

Replace economy

PUT/v1/gamification/chests/economy

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

if-match*string

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/v1/gamification/chests/economy" \  -H "if-match: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Grant chest

POST/v1/gamification/chests/grants

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-progress:replay · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/gamification/chests/grants" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read chest settings

GET/v1/gamification/chests/settings

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/gamification/chests/settings"

Empty

Replace chest settings

PUT/v1/gamification/chests/settings

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/v1/gamification/chests/settings" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Archive event registry

POST/v1/gamification/event-registry/{eventKey}/archive

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-config:mutate

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventKey*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/gamification/event-registry/string/archive"

Empty

Delete event registry

DELETE/v1/gamification/event-registry/{eventKey}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-config:mutate

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventKey*string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/gamification/event-registry/string"

Empty

Read registered event

GET/v1/gamification/event-registry/{eventKey}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

eventKey*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/gamification/event-registry/string"

Empty

List registered events

GET/v1/gamification/event-registry

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/gamification/event-registry"

Empty

Create event registry

POST/v1/gamification/event-registry

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-config:mutate

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/gamification/event-registry" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Create event

POST/v1/gamification/events

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-events:ingest · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

eventKey*string

Match^[a-z0-9]+(?:-[a-z0-9]+)*:[a-z0-9]+(?:-[a-z0-9]+)*$

playerId*string

Length1 <= length <= 200

payload*

Response Body

`application/json`

curl -X POST "https://example.com/v1/gamification/events" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "eventKey": "string",    "playerId": "string",    "payload": {}  }'

Empty

Read leaderboard

GET/v1/gamification/leaderboards/{period}/{entityType}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-progress:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

period*string

entityType*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/gamification/leaderboards/string/string"

Empty

Read level curve revision

GET/v1/gamification/levels/curve/{revision}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

revision*number

Response Body

`application/json`

curl -X GET "https://example.com/v1/gamification/levels/curve/0"

Empty

Read level curve

GET/v1/gamification/levels/curve

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/gamification/levels/curve"

Empty

Replace curve

PUT/v1/gamification/levels/curve

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

if-match*string

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/v1/gamification/levels/curve" \  -H "if-match: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read progress

GET/v1/gamification/players/{playerId}/progress

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-progress:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

playerId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/gamification/players/string/progress"

Empty

POST/v1/gamification/replay

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-progress:replay · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/gamification/replay" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Create server event

POST/v1/gamification/server-events

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-events:ingest · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

eventKey*string

Match^[a-z0-9]+(?:-[a-z0-9]+)*:[a-z0-9]+(?:-[a-z0-9]+)*$

playerId*string

Length1 <= length <= 200

payload*

Response Body

`application/json`

curl -X POST "https://example.com/v1/gamification/server-events" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "eventKey": "string",    "playerId": "string",    "payload": {}  }'

Empty

Read tier settings

GET/v1/gamification/tiers/settings

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/gamification/tiers/settings"

Empty

Replace tier settings

PUT/v1/gamification/tiers/settings

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: gamification-catalog:author

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

Response Body

`application/json`

curl -X PUT "https://example.com/v1/gamification/tiers/settings" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read KPI summary

GET/v1/kpi/summary

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/kpi/summary"

Empty

Read KPI trends

GET/v1/kpi/trends

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/kpi/trends"

Empty

Archive membership tier

POST/v1/membership-tiers/{levelKey}/archive

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: API key · Required scope: player-membership-tier:author · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

levelKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/membership-tiers/string/archive" \  -H "Idempotency-Key: string"

Empty

Set default membership tier

POST/v1/membership-tiers/{levelKey}/default

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: API key · Required scope: player-membership-tier:author · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

levelKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/membership-tiers/string/default" \  -H "Idempotency-Key: string"

Empty

Publish membership tier

POST/v1/membership-tiers/{levelKey}/publish

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: API key · Required scope: player-membership-tier:author · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

levelKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/membership-tiers/string/publish" \  -H "Idempotency-Key: string"

Empty

Update membership tier

PATCH/v1/membership-tiers/{levelKey}

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: API key · Required scope: player-membership-tier:author · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

levelKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

displayName*string

Length1 <= length <= 128

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/membership-tiers/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "displayName": "string"  }'

Empty

List membership tiers

GET/v1/membership-tiers

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: API key · Required scope: player-membership-tier:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/membership-tiers"

Empty

Create membership tier

POST/v1/membership-tiers

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: API key · Required scope: player-membership-tier:author · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

levelKey*string

Match^[a-z0-9]+(?:-[a-z0-9]+)*$

Lengthlength <= 128

displayName*string

Length1 <= length <= 128

Response Body

`application/json`

curl -X POST "https://example.com/v1/membership-tiers" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "levelKey": "string",    "displayName": "string"  }'

Empty

Read nickname pricing

GET/v1/nickname-pricing

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: API key · Required scope: player-rename:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/nickname-pricing"

Empty

Replace nickname pricing

PUT/v1/nickname-pricing

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: API key · Required scope: player-rename:configure · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

currencyKey*string

Match^[a-z0-9]+(?:-[a-z0-9]+)*$

amount*integer

Range0 <= value <= 1000000000

Response Body

`application/json`

curl -X PUT "https://example.com/v1/nickname-pricing" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "currencyKey": "string",    "amount": 0  }'

Empty

Reconcile payout

POST/v1/payouts/{payoutId}/reconcile

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

payoutId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/payouts/string/reconcile" \  -H "Idempotency-Key: string"

Empty

Read payout capabilities

GET/v1/payouts/capabilities

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/payouts/capabilities"

Empty

List payouts

GET/v1/payouts

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/payouts"

Empty

Read player membership

GET/v1/player-memberships/{playerId}

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: API key · Required scope: player-membership:grant

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

playerId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/player-memberships/string"

Empty

Grant player membership

POST/v1/player-memberships/grant

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: API key · Required scope: player-membership:grant · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

if-match*string

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

playerId*string

Length1 <= length <= 256

levelKey*string

Match^[a-z0-9]+(?:-[a-z0-9]+)*$

Lengthlength <= 128

startsAt?string

Formatdate-time

endsAt?string

Formatdate-time

source?string

Length1 <= length <= 128

externalReference?string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/player-memberships/grant" \  -H "if-match: string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "playerId": "string",    "levelKey": "string"  }'

Empty

Revoke player membership

POST/v1/player-memberships/revoke

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: API key · Required scope: player-membership:revoke · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

if-match*string

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

playerId*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/player-memberships/revoke" \  -H "if-match: string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "playerId": "string"  }'

Empty

Create player notification

POST/v1/player-notifications

API: Notification · Base URL: $NOTIFICATION_API_URL · Authentication: API key · Required scope: notifications:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/player-notifications" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read private Player contact

GET/v1/players/{playerId}/contact

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: API key · Required scope: players:contact:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

playerId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/players/string/contact"

Empty

Update private Player contact

PUT/v1/players/{playerId}/contact

API: Identity · Base URL: $IDENTITY_API_URL · Authentication: API key · Required scope: players:contact:mutate · Requires an Idempotency-Key header

Clerk callers must be organization administrators. API-key callers require the declared scopes; a Clerk organization role is not required for API keys.

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

playerId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

email*|

Lengthlength <= 254

contactRevision*integer

Range0 <= value

Response Body

`application/json`

curl -X PUT "https://example.com/v1/players/string/contact" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "contactRevision": 0  }'

Empty

Recover or cancel a Quiz reward allocation

POST/v1/quizzes/{quizId}/allocations/{playerId}/{action}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: quizzes:recover · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

quizId*string

playerId*string

action*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

reason*string

Length1 <= length <= 1000

Response Body

`application/json`

curl -X POST "https://example.com/v1/quizzes/string/allocations/string/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "reason": "string"  }'

Empty

List Quiz reward allocations

GET/v1/quizzes/{quizId}/allocations

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: quizzes:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

quizId*string

Query Parameters

cursor*string

limit*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/quizzes/string/allocations?cursor=string&limit=string"

Empty

Read Quiz participation analytics

GET/v1/quizzes/{quizId}/analytics

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: quizzes:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

quizId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/quizzes/string/analytics"

Empty

Extend Quiz availability

POST/v1/quizzes/{quizId}/extend

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: quizzes:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

quizId*string

Header Parameters

if-match*string

If-Match*string

Current Quiz configuration revision

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

endsAt*string

Formatdate-time

Response Body

`application/json`

curl -X POST "https://example.com/v1/quizzes/string/extend" \  -H "if-match: string" \  -H "If-Match: string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "endsAt": "2019-08-24T14:15:22Z"  }'

Empty

Publish a Quiz

POST/v1/quizzes/{quizId}/publish

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: quizzes:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

quizId*string

Header Parameters

if-match*string

If-Match*string

Current Quiz configuration revision

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/quizzes/string/publish" \  -H "if-match: string" \  -H "If-Match: string" \  -H "Idempotency-Key: string"

Empty

Read a tenant Quiz definition

GET/v1/quizzes/{quizId}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: quizzes:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

quizId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/quizzes/string"

Empty

Update a draft Quiz definition

PATCH/v1/quizzes/{quizId}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: quizzes:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

quizId*string

Header Parameters

if-match*string

If-Match*string

Current Quiz configuration revision

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

title*string

Length1 <= length <= 200

description*string

Length0 <= length <= 10000

coverImage*string

Match^qmedia_[a-f0-9]{64}$

questions*array<>

Items0 <= items <= 30

threshold*integer

Range0 <= value <= 100

secondsPerQuestion*integer

Range1 <= value <= 3600

shuffleQuestions*boolean

shuffleAnswers*boolean

attemptLimit*integer

Range1 <= value <= 100

eligibility*array<|||||||||>

Items0 <= items <= 20

currencyKey*string

Match^$|^[a-z0-9]+(?:-[a-z0-9]+)*$

rewardPerWinner*integer

Range1 <= value <= 9007199254740991

maximumWinners*integer

Range1 <= value <= 1000000

startsAt*string

Length0 <= length <= 40

endsAt*string

Length0 <= length <= 40

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/quizzes/string" \  -H "if-match: string" \  -H "If-Match: string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "description": "string",    "coverImage": "string",    "questions": [],    "threshold": 0,    "secondsPerQuestion": 1,    "shuffleQuestions": true,    "shuffleAnswers": true,    "attemptLimit": 1,    "eligibility": [],    "currencyKey": "string",    "rewardPerWinner": 1,    "maximumWinners": 1,    "startsAt": "string",    "endsAt": "string"  }'

Empty

Read a tenant Quiz cover

GET/v1/quizzes/media/{mediaId}

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: quizzes:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

mediaId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/quizzes/media/string"

Empty

Upload a tenant Quiz cover

POST/v1/quizzes/media

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: quizzes:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

contentType*unknown

Value in

"image/png"
"image/jpeg"
"image/webp"

data*string

Length1 <= length <= 13981016

Response Body

`application/json`

curl -X POST "https://example.com/v1/quizzes/media" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "contentType": "image/png",    "data": "string"  }'

Empty

List tenant quizzes

GET/v1/quizzes

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: quizzes:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Query Parameters

cursor*string

limit*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/quizzes?cursor=string&limit=string"

Empty

Create a draft quiz

POST/v1/quizzes

API: Gamification · Base URL: $GAMIFICATION_API_URL · Authentication: API key · Required scope: quizzes:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

title*string

Length1 <= length <= 200

description*string

Length0 <= length <= 10000

coverImage*string

Match^qmedia_[a-f0-9]{64}$

questions*array<>

Items0 <= items <= 30

threshold*integer

Range0 <= value <= 100

secondsPerQuestion*integer

Range1 <= value <= 3600

shuffleQuestions*boolean

shuffleAnswers*boolean

attemptLimit*integer

Range1 <= value <= 100

eligibility*array<|||||||||>

Items0 <= items <= 20

currencyKey*string

Match^$|^[a-z0-9]+(?:-[a-z0-9]+)*$

rewardPerWinner*integer

Range1 <= value <= 9007199254740991

maximumWinners*integer

Range1 <= value <= 1000000

startsAt*string

Length0 <= length <= 40

endsAt*string

Length0 <= length <= 40

Response Body

`application/json`

curl -X POST "https://example.com/v1/quizzes" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "description": "string",    "coverImage": "string",    "questions": [],    "threshold": 0,    "secondsPerQuestion": 1,    "shuffleQuestions": true,    "shuffleAnswers": true,    "attemptLimit": 1,    "eligibility": [],    "currencyKey": "string",    "rewardPerWinner": 1,    "maximumWinners": 1,    "startsAt": "string",    "endsAt": "string"  }'

Empty

Create retry

POST/v1/redeemable-key-redemptions/{redemptionId}/retry

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

redemptionId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/redeemable-key-redemptions/string/retry" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read redeemable key redemption

GET/v1/redeemable-key-redemptions/{redemptionId}

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

redemptionId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/redeemable-key-redemptions/string"

Empty

List redeemable key redemptions

GET/v1/redeemable-key-redemptions

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/redeemable-key-redemptions"

Empty

Revoke redeemable key

POST/v1/redeemable-keys/{keyId}/revoke

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

keyId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/redeemable-keys/string/revoke" \  -H "Idempotency-Key: string"

Empty

Read redeemable key

GET/v1/redeemable-keys/{keyId}

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

keyId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/redeemable-keys/string"

Empty

List redeemable keys

GET/v1/redeemable-keys

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/redeemable-keys"

Empty

Create redeemable key

POST/v1/redeemable-keys

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/redeemable-keys" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read reward grant

GET/v1/reward-grants/{playerId}

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

playerId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/reward-grants/string"

Empty

Search tenant records

GET/v1/search

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/search"

Empty

Publish listing

POST/v1/shop/listings/{listingKey}/publish

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: shop:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

listingKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/shop/listings/string/publish" \  -H "Idempotency-Key: string"

Empty

Retire listing

POST/v1/shop/listings/{listingKey}/retire

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: shop:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

listingKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/shop/listings/string/retire" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Add stock codes to listing

POST/v1/shop/listings/{listingKey}/stock/codes

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: shop:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

listingKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/shop/listings/string/stock/codes" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read listing

GET/v1/shop/listings/{listingKey}

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: shop:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

listingKey*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/shop/listings/string"

Empty

Update listing

PATCH/v1/shop/listings/{listingKey}

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: shop:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

listingKey*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/shop/listings/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

List listings

GET/v1/shop/listings

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: shop:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/shop/listings"

Empty

Create listing

POST/v1/shop/listings

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: shop:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/shop/listings" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Claim order

POST/v1/shop/orders/{orderId}/claim

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: shop:fulfill · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

orderId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Response Body

`application/json`

curl -X POST "https://example.com/v1/shop/orders/string/claim" \  -H "Idempotency-Key: string"

Empty

Create code disclosure

POST/v1/shop/orders/{orderId}/code-disclosures

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: shop:disclose-code

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

orderId*string

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/shop/orders/string/code-disclosures" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Fulfil shop order

POST/v1/shop/orders/{orderId}/fulfillment

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: shop:fulfill · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

orderId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/shop/orders/string/fulfillment" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Create reversal

POST/v1/shop/orders/{orderId}/reversal

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: shop:reverse · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

orderId*string

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/shop/orders/string/reversal" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read order

GET/v1/shop/orders/{orderId}

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: shop:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

orderId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/shop/orders/string"

Empty

List orders

GET/v1/shop/orders

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: shop:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/shop/orders"

Empty

Post wallet value movement

POST/v1/wallet-value/post

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

Length1 <= length <= 256

Request Body

application/json

Response Body

`application/json`

curl -X POST "https://example.com/v1/wallet-value/post" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Read wallet

GET/v1/wallets/{playerId}

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

playerId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/wallets/string"

Empty

Read Web3 capabilities

GET/v1/web3/capabilities

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/web3/capabilities"

Empty

Re-verify Web3 deployments

POST/v1/web3/deployments/verifications

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X POST "https://example.com/v1/web3/deployments/verifications"

Empty

List deployments

GET/v1/web3/deployments

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/web3/deployments"

Empty

Read self test

GET/v1/web3/self-tests/{selfTestId}

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Path Parameters

selfTestId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/web3/self-tests/string"

Empty

List self tests

GET/v1/web3/self-tests

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:read

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

Query Parameters

chain*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/web3/self-tests?chain=string"

Empty

Create self test

POST/v1/web3/self-tests

API: Reward · Base URL: $REWARD_API_URL · Authentication: API key · Required scope: rewards:mutate · Requires an Idempotency-Key header

Authorization

apiKeyBearer

AuthorizationBearer <token>

In: header

`application/json`

curl -X POST "https://example.com/v1/web3/self-tests" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

API reference

Check in enrollmentCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

201

401application/json

403application/json

429application/json

defaultapplication/json

Confirm enrollmentCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

201

401application/json

403application/json

429application/json

defaultapplication/json

Accept rosterCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

201

401application/json

403application/json

429application/json

defaultapplication/json

Reject rosterCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

201

401application/json

403application/json

429application/json

defaultapplication/json

Withdraw enrollmentCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

201

401application/json

403application/json

429application/json

defaultapplication/json

Delete enrollmentCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200

401application/json

403application/json

429application/json

defaultapplication/json

Update enrollmentCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200

401application/json

403application/json

429application/json

defaultapplication/json

Create enrollmentCopy Anchor Link

AuthorizationCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201

401application/json

403application/json

Check in enrollment

Authorization

Path Parameters

Header Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Confirm enrollment

Authorization

Path Parameters

Header Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Accept roster

Authorization

Path Parameters

Header Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Reject roster

Authorization

Path Parameters

Header Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Withdraw enrollment

Authorization

Path Parameters

Header Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Delete enrollment

Authorization

Path Parameters

Header Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Update enrollment

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Create enrollment

Authorization

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Complete upload

Authorization

Path Parameters

Header Parameters

Response Body

`application/json`

`application/json`