Skip to main content
GET
/
tickets
/
config
Get tickets configuration
curl --request GET \
  --url https://api.series.hr/tickets/config \
  --header 'apikey: <api-key>'
Requires Premium or Enterprise subscription

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

success
boolean
Whether the request was successful
data
object

Example

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

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

{
  "success": false,
  "error": {
    "code": 403,
    "message": "Tickets module requires a Premium or Enterprise subscription"
  }
}
{
  "success": false,
  "error": {
    "code": 403,
    "message": "Tickets module is not enabled for this workspace"
  }
}

Rate Limit

25 requests per second per API key

Authorizations

apikey
string
header
required

Pass your API key in the apikey header. Alternatively, the x-api-key header is also accepted.

Response

Configuration returned successfully