> ## Documentation Index
> Fetch the complete documentation index at: https://docs.series.hr/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Configuration

> Retrieve the tickets configuration for the workspace

<Warning>
  **Requires Premium or Enterprise subscription**
</Warning>

## 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

<ResponseField name="success" type="boolean">
  Whether the request was successful
</ResponseField>

<ResponseField name="data" type="object">
  <Expandable title="properties">
    <ResponseField name="Enabled" type="boolean">
      Whether the tickets module is enabled
    </ResponseField>

    <ResponseField name="PublicUrl" type="boolean">
      Whether public URL is enabled
    </ResponseField>

    <ResponseField name="Categories" type="object">
      Available ticket categories with their settings
    </ResponseField>

    <ResponseField name="Departments" type="object">
      Available departments with their members and categories
    </ResponseField>

    <ResponseField name="DiscordNotificationWebhookEnabled" type="boolean">
      Whether Discord notifications are enabled
    </ResponseField>

    <ResponseField name="DiscordNotificationWebhookPing" type="string">
      Discord role ID to ping (if configured)
    </ResponseField>
  </Expandable>
</ResponseField>

## Example

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://api.series.hr/tickets/config" \
    -H "apikey: YOUR_API_KEY"
  ```

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

  const data = await response.json();
  ```

  ```lua Lua (Roblox) theme={null}
  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)
  ```

  ```python Python theme={null}
  import requests

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

  data = response.json()
  ```
</CodeGroup>

## Response Example

```json theme={null}
{
  "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

<AccordionGroup>
  <Accordion title="403 - Premium Required">
    ```json theme={null}
    {
      "success": false,
      "error": {
        "code": 403,
        "message": "Tickets module requires a Premium or Enterprise subscription"
      }
    }
    ```
  </Accordion>

  <Accordion title="403 - Module Not Enabled">
    ```json theme={null}
    {
      "success": false,
      "error": {
        "code": 403,
        "message": "Tickets module is not enabled for this workspace"
      }
    }
    ```
  </Accordion>
</AccordionGroup>

## Rate Limit

**25 requests per second** per API key


## OpenAPI

````yaml GET /tickets/config
openapi: 3.0.0
info:
  title: Series API
  version: 1.0.0
  description: >-
    Series API — a free REST API by Sailboat Games, LLC that lets Roblox
    communities programmatically manage workspaces, staff, sessions, time-off
    and activity data.
  contact:
    name: Sailboat Games, LLC.
    email: admin@sailboatgames.com
servers:
  - url: https://api.series.hr
    description: Production API
security:
  - ApiKeyAuth: []
paths:
  /tickets/config:
    get:
      tags:
        - Tickets
      summary: Get tickets configuration
      description: >-
        Retrieve the tickets configuration for the workspace. Requires Premium
        or Enterprise subscription.
      responses:
        '200':
          description: Configuration returned successfully
        '401':
          description: API key is required
        '403':
          description: Tickets module not enabled or Premium required
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: >-
        Pass your API key in the `apikey` header. Alternatively, the `x-api-key`
        header is also accepted.

````