Skip to main content
API docs by Redocly

Theymes API (1.0.0)

Download OpenAPI specification:Download

Theymes API allows you to interact with the Theymes platform.

Most endpoints require an API key for authentication. You can generate an API key in the Theymes dashboard.

The API key should be included in the Authorization header (Authorization: Bearer <YOUR_KEY>).

The public support link endpoints do not require authentication and are grouped separately below.

Authenticated endpoints (API key)

Endpoints that require an API key in the Authorization header.

getTickets

Get tickets

query Parameters
playerId
string
email
string
gameId
string <uuid>
ticketId
string <uuid>
createdAfter
string <date>

Only return tickets created on or after this date

createdBefore
string <date>

Only return tickets created on or before this date

order
string
Default: "asc"
Enum: "asc" "desc"

Sort by ticket creation order, oldest first or newest first

cursor
string

Pagination cursor returned from a previous response. Must be used with the same order direction it was obtained with. Omit when starting a new scan.

limit
integer [ 1 .. 1000 ]
Default: 100
header Parameters
Authorization
required
string

Bearer token API key

Responses

Response samples

Content type
application/json
{
  • "tickets": [
    ],
  • "pagination": {
    }
}

createTicket

Create a new ticket. To include attachments, call POST /attachments to obtain upload URLs, upload the files, and pass the returned attachment IDs in the attachments array.

header Parameters
Authorization
required
string

Bearer token API key

Request Body schema: application/json
gameId
required
string <uuid>
message
required
string
attachments
Array of strings
Default: []

List of attachment IDs returned by POST /attachments after the file upload completes.

skipDuplicateCheck
boolean
Default: false

If true, the duplicate ticket check will be skipped.

language
required
string
Enum: "en" "de" "es" "es-AR" "es-MX" "fi" "fil" "fr" "id" "ja" "ko" "ms" "pt" "pt-BR" "ru" "tr" "uk" "vi" "zh" "zh-Hans" "zh-Hant" "ar" "cs" "da" "nl" "el" "hu" "it" "no" "nb" "pl" "ro" "sk" "sv" "th"
channels
required
Array of strings non-empty
Items Value: "email"
required
object

Responses

Request samples

Content type
application/json
{
  • "gameId": "3f0eee32-8eac-4668-9b38-e3e5dc21d607",
  • "message": "string",
  • "attachments": [ ],
  • "skipDuplicateCheck": false,
  • "language": "en",
  • "channels": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "ticketId": "e3e3e8ea-b02a-4536-85a2-a9c90f4ee74f"
}

prepareAttachmentUpload

Generate a pre-signed upload URL for a ticket attachment. Upload the file with an HTTP PUT request to the returned URL, then pass the attachment ID in the POST /tickets request.

header Parameters
Authorization
required
string

Bearer token API key

Request Body schema: application/json
gameId
required
string <uuid>
fileName
required
string non-empty
fileType
required
string
Enum: "image/svg+xml" "image/png" "image/jpeg" "image/gif" "application/pdf" "video/mp4" "video/quicktime" "text/plain" "application/zip" "application/vnd.rar"
fileSize
required
integer ( 0 .. 209715200 ]

Size of the file in bytes. Maximum allowed size is 200 MB.

playerId
string or null non-empty

Optional player identifier to associate with the uploaded attachment.

Responses

Request samples

Content type
application/json
{
  • "gameId": "3f0eee32-8eac-4668-9b38-e3e5dc21d607",
  • "fileName": "string",
  • "fileType": "image/svg+xml",
  • "fileSize": 0,
  • "playerId": "string"
}

Response samples

Content type
application/json
{
  • "attachmentId": "string",
  • "uploadUrl": "http://example.com",
  • "uploadMethod": "PUT",
  • "uploadHeaders": {
    },
  • "uploadExpiresInSeconds": 0
}

downloadAttachment

Redirect to a short-lived signed URL for downloading a previously uploaded ticket attachment.

path Parameters
attachmentId
required
string

Attachment ID returned by POST /attachments.

header Parameters
Authorization
required
string

Bearer token API key

Responses

performTicketActions

Perform actions on a ticket such as managing metadata, sending messages, assigning, and closing

path Parameters
ticketId
required
string <uuid>

The ID of the ticket to perform actions on

header Parameters
Authorization
required
string

Bearer token API key

Request Body schema: application/json
required
Array of addTags (object) or setFields (object) or setOnHold (object) or setPlayerInfo (object) or sendMessage (object) or addPrivateNote (object) or resolveTicket (object) or rejectTicket (object) or assignTicket (object) or unassignTicket (object) or removeTags (object) non-empty
Array (non-empty)
One of
type
required
string
Value: "addTags"
tagNames
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "actions": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

getTicketEvents

Get selected ticket events, including message attachments as downloadable attachment IDs.

path Parameters
ticketId
required
string <uuid>

The ID of the ticket to fetch events for

header Parameters
Authorization
required
string

Bearer token API key

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

getTicketBreadcrumbs

Get SDK breadcrumbs captured for a ticket.

path Parameters
ticketId
required
string <uuid>

The ID of the ticket to fetch breadcrumbs for

header Parameters
Authorization
required
string

Bearer token API key

Responses

Response samples

Content type
application/json
{
  • "breadcrumbs": [
    ],
  • "clientClockOffsetMs": 0
}

getGames

Get games for the company associated with the API key

header Parameters
Authorization
required
string

Bearer token API key

Responses

Response samples

Content type
application/json
{
  • "games": [
    ]
}

getTags

Get tags for the company associated with the API key

header Parameters
Authorization
required
string

Bearer token API key

Responses

Response samples

Content type
application/json
{
  • "tags": [
    ]
}

getFields

Get fields for the company associated with the API key

header Parameters
Authorization
required
string

Bearer token API key

Responses

Response samples

Content type
application/json
{
  • "fields": [
    ]
}

schedulePlayerDeletion

Schedule deletion of a player's data. The player will be scheduled to be deleted in 24 hours. The scheduled deletion can be cancelled from the Theymes application if necessary.

header Parameters
Authorization
required
string

Bearer token API key

Request Body schema: application/json
theymesPlayerId
required
string <uuid>

The Theymes Player ID, can be found with the ticket API.

Responses

Request samples

Content type
application/json
{
  • "theymesPlayerId": "f07c797a-5ed6-4a80-a34d-f79f201130ce"
}

Response samples

Content type
application/json
{
  • "success": true
}