List Tickets

Requires Premium or Enterprise subscription

Overview

Retrieve a paginated list of tickets with optional filtering by status, author, department, and search query. For staff users: Use staffUserId parameter to filter tickets by your department access permissions.

Query Parameters

integer

Page number for pagination (default: 1)

string

Filter by status: open, in-progress, resolved, closed

string

Filter by author UserId

string

Filter by department ID

string

Search by subject, author username, or display name

integer

UserId for permission filtering (staff only). Filters tickets by department access.

Response

boolean

Whether the request was successful

object

Show properties

array

Array of ticket objects

object

Pagination info including CurrentPage, TotalPages, TotalCount, etc.

Example

curl -X GET "https://api.series.hr/tickets/list?page=1&status=open" \
  -H "apikey: YOUR_API_KEY"

const response = await fetch('https://api.series.hr/tickets/list?page=1&status=open', {
  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/list?page=1&status=open",
    Method = "GET",
    Headers = {
        ["apikey"] = "YOUR_API_KEY"
    }
})

local data = HttpService:JSONDecode(response.Body)

import requests

response = requests.get(
    'https://api.series.hr/tickets/list?page=1&status=open',
    headers={'apikey': 'YOUR_API_KEY'}
)

data = response.json()

Response Example

{
  "success": true,
  "data": {
    "Tickets": [
      {
        "_id": "...",
        "TicketId": "TICKET-1234567890-ABCD",
        "Subject": "Help with ranking",
        "Category": "support",
        "Department": "support-dept",
        "Status": "open",
        "Priority": "medium",
        "ClaimedBy": 987654321,
        "ClaimedByName": "Staff Member",
        "Author": {
          "UserId": 123456789,
          "Username": "player123",
          "DisplayName": "Player Name",
          "AvatarUrl": "https://..."
        },
        "CreatedAt": "2025-01-15T10:30:00.000Z",
        "UpdatedAt": "2025-01-15T10:30:00.000Z",
        "GameReport": false
      }
    ],
    "Pagination": {
      "CurrentPage": 1,
      "TotalPages": 5,
      "TotalCount": 42,
      "TicketsPerPage": 10,
      "HasNextPage": true,
      "HasPreviousPage": false
    }
  }
}

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"
  }
}

Rate Limit

25 requests per second per API key

Introduction & basics

Basic

Activity

Activity Credits

Sessions

Attendance

Game Moderation

Applications

Members

Time-Off

Hotel

Food & Beverage

Ranking

Flights

Tickets

Overview

Query Parameters

Response

Example

Response Example

Error Responses

Rate Limit

​Overview

​Query Parameters

​Response

​Example

​Response Example

​Error Responses

​Rate Limit

Overview

Query Parameters

Response

Example

Response Example

Error Responses

Rate Limit