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

# List tickets

> Lists your tickets, most recently updated first. By default only tickets updated in the last 14 days are returned; send `status=ALL` to get all of them.



## OpenAPI

````yaml /spec/platform-support.yaml get /v1/tickets
openapi: 3.0.1
info:
  title: Support & Notifications
  version: 1.0.0
  description: |
    Open and follow support tickets, read your notifications, and choose
    where notifications are delivered (SMS, email or Telegram).

    With `teamID`, these endpoints work on the team's tickets, notifications
    and channels. The description of each endpoint says which permission it
    needs in the team.
servers:
  - url: https://api.liara.ir
security:
  - bearerAuth: []
tags:
  - name: Tickets
    description: Open, reply to and close support tickets.
  - name: Attachments
    description: Upload files to attach to tickets, and download them.
  - name: Notifications
    description: Read notifications and set the low-credit alert threshold.
  - name: Notification Channels
    description: Choose which notifications are sent by SMS, email or Telegram.
paths:
  /v1/tickets:
    get:
      tags:
        - Tickets
      summary: List tickets
      description: >-
        Lists your tickets, most recently updated first. By default only tickets
        updated in the last 14 days are returned; send `status=ALL` to get all
        of them.
      operationId: listTickets
      parameters:
        - $ref: '#/components/parameters/TeamID'
        - name: status
          in: query
          required: false
          description: Send `ALL` to include tickets not updated in the last 14 days.
          schema:
            type: string
            enum:
              - ALL
        - name: page
          in: query
          required: false
          description: Page number, starting at 1. Use it together with `count`.
          schema:
            type: integer
            minimum: 1
        - name: count
          in: query
          required: false
          description: Tickets per page. Without it, all matching tickets are returned.
          schema:
            type: integer
            minimum: 1
      responses:
        '200':
          description: Your tickets.
          content:
            application/json:
              schema:
                type: object
                properties:
                  tickets:
                    type: array
                    items:
                      $ref: '#/components/schemas/TicketSummary'
                  allTicketsCount:
                    type: integer
                    description: Total number of matching tickets.
              example:
                tickets:
                  - _id: '000000000000000000000100'
                    shortID: 12345
                    subject: مشکل در استقرار برنامه
                    status: ANSWERED
                    pendingBy: false
                    category: TECHNICAL
                    user:
                      _id: '000000000000000000000001'
                      fullname: نام نمونه
                      email: you@example.com
                      phone: '09120000000'
                    subscriptionPlan:
                      _id: '000000000000000000000003'
                      subscriptionPlanID: standard
                    created_at: '2026-01-01T08:00:00.000Z'
                    updated_at: '2026-01-01T09:00:00.000Z'
                allTicketsCount: 1
        '400':
          $ref: '#/components/responses/InvalidTeamID'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TeamNotFound'
components:
  parameters:
    TeamID:
      name: teamID
      in: query
      required: false
      description: >-
        Run the request in the context of a team you belong to, instead of your
        personal account.
      schema:
        $ref: '#/components/schemas/ObjectID'
      example: '000000000000000000000002'
  schemas:
    TicketSummary:
      type: object
      properties:
        _id:
          type: string
        shortID:
          type: integer
          description: Short ticket number shown to people.
        subject:
          type: string
        status:
          $ref: '#/components/schemas/TicketStatus'
        pendingBy:
          type: boolean
          description: Whether the ticket is marked as being worked on.
        category:
          $ref: '#/components/schemas/TicketCategory'
        user:
          type: object
          description: The account that owns the ticket.
          properties:
            _id:
              type: string
            fullname:
              type: string
            email:
              type: string
            phone:
              type: string
            teamName:
              type: string
            teamColor:
              type: string
        actor:
          type: object
          description: For team tickets, the person who opened it.
          properties:
            fullname:
              type: string
            email:
              type: string
            avatar:
              type: string
              format: uri
        subscriptionPlan:
          type: object
          description: The subscription plan the account had when the ticket was opened.
          properties:
            _id:
              type: string
            subscriptionPlanID:
              type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ObjectID:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      description: 24-character hexadecimal ID.
    TicketStatus:
      type: string
      description: >-
        `OPEN`: waiting for support. `ANSWERED`: support replied. `PENDING`:
        support is working on it. `UPGRADE_REQUIRED`: support says it needs a
        plan upgrade. `CLOSED`: closed.
      enum:
        - OPEN
        - ANSWERED
        - PENDING
        - UPGRADE_REQUIRED
        - CLOSED
    TicketCategory:
      type: string
      enum:
        - TECHNICAL
        - BILLING
        - MIGRATION
        - REPORT
        - FEEDBACK
    Error:
      type: object
      description: Standard error body.
      properties:
        statusCode:
          type: integer
        error:
          type: string
          description: HTTP status text.
        message:
          type: string
          description: What went wrong.
        data:
          type: object
          nullable: true
          description: >-
            Extra details. When present, `code` is a stable, machine-readable
            error code.
          properties:
            code:
              type: string
    AuthError:
      type: object
      description: Error body returned when the API token is rejected.
      properties:
        error:
          type: string
  responses:
    InvalidTeamID:
      description: '`teamID` isn''t a valid ID.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 400
            error: Bad Request
            message: Invalid team ID.
            data: null
    Unauthorized:
      description: The API token is missing, invalid or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthError'
          example:
            error: Unauthorized.
    TeamNotFound:
      description: You sent a `teamID` for a team you aren't a member of.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 403
            error: Forbidden
            message: Team not found
            data:
              code: team_not_found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Send your API token as `Authorization: Bearer <api-token>`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.