Skip to main content
GET
/
tickets
/
list
List tickets
curl --request GET \
  --url https://api.series.hr/tickets/list \
  --header 'apikey: <api-key>'
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

​
page
integer
Page number for pagination (default: 1)
​
status
string
Filter by status: open, in-progress, resolved, closed
​
author
string
Filter by author UserId
​
department
string
Filter by department ID
​
search
string
Search by subject, author username, or display name
​
staffUserId
integer
UserId for permission filtering (staff only). Filters tickets by department access.

​
Response

​
success
boolean
Whether the request was successful
​
data
object

​
Example

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

​
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

{
  "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.

Query Parameters

​
page
integer
default:1

Page number for pagination

​
status
enum<string>

Filter by ticket status

Available options:
open,
in-progress,
resolved,
closed
​
author
string

Filter by author UserId

​
department
string

Filter by department ID

​
search
string

Search by subject, author username, or display name

​
staffUserId
integer

UserId for permission filtering (staff only)

Response

Tickets list returned successfully