Get Configuration

Overview

Retrieve the tickets configuration for the workspace, including categories, departments, and Discord notification settings.

Use this endpoint to understand:

Which categories are available for ticket creation

Whether workspace membership is required for each category

The maximum number of open tickets allowed per category

Which departments handle which categories

Discord notification settings

Response

boolean

Whether the request was successful

object

Show properties

boolean

Whether the tickets module is enabled

boolean

Whether public URL is enabled

object

Available ticket categories with their settings

object

Available departments with their members and categories

boolean

Whether Discord notifications are enabled

string

Discord role ID to ping (if configured)

Example

curl -X GET "https://api.series.hr/tickets/config" \
  -H "apikey: YOUR_API_KEY"

const response = await fetch('https://api.series.hr/tickets/config', {
  headers: {
    'apikey': 'YOUR_API_KEY'
  }
});

const data = await response.json();

local HttpService = game:GetService("HttpService")

local response = HttpService:RequestAsync({
    Url = "https://api.series.hr/tickets/config",
    Method = "GET",
    Headers = {
        ["apikey"] = "YOUR_API_KEY"
    }
})

local data = HttpService:JSONDecode(response.Body)

import requests

response = requests.get(
    'https://api.series.hr/tickets/config',
    headers={'apikey': 'YOUR_API_KEY'}
)

data = response.json()

Response Example

{
  "success": true,
  "data": {
    "Enabled": true,
    "PublicUrl": false,
    "Categories": {
      "support": {
        "Name": "Support",
        "WorkspaceMembershipRequired": false,
        "MinAccessRank": 0,
        "MaxOpenTickets": 5
      }
    },
    "Departments": {
      "support-dept": {
        "Name": "Support Department",
        "Members": [987654321],
        "Categories": ["support"],
        "RankRange": {
          "FromRank": 100,
          "ToRank": 255
        }
      }
    },
    "DiscordNotificationWebhookEnabled": true,
    "DiscordNotificationWebhookPing": "1234567890123456789"
  }
}

Error Responses

403 - Premium Required

{
  "success": false,
  "error": {
    "code": 403,
    "message": "Tickets module requires a Premium or Enterprise subscription"
  }
}

403 - Module Not Enabled

{
  "success": false,
  "error": {
    "code": 403,
    "message": "Tickets module is not enabled for this workspace"
  }
}

Introduction & basics

Basic

Activity

Activity Credits

Sessions

Attendance

Game Moderation

Applications

Members

Time-Off

Hotel

Food & Beverage

Ranking

Flights

Tickets

Overview

Response

Example

Response Example

Error Responses

Rate Limit

​Overview

​Response

​Example

​Response Example

​Error Responses

​Rate Limit

Overview

Response

Example

Response Example

Error Responses

Rate Limit