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

# Lists tickets

> Lists tickets for the service provider using cursor pagination. Default sort is `updatedOn desc`. sortBy accepts only `updatedOn` or `createdOn`; sortOrder accepts only `asc` or `desc` (case-insensitive) — any other value is rejected with a 400.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/tickets
openapi: 3.0.4
info:
  title: Public API
  description: Gorelo Public API documentation.
  version: 1.0.0
servers:
  - url: https://api.usw.gorelo.io
    description: US
  - url: https://api.aue.gorelo.io
    description: Australia
security:
  - ApiKeyAuth: []
tags:
  - name: Attachments
    description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs."
  - name: Alerts
    description: Alerts management operations
  - name: Assets
    description: Assets management operations
  - name: Billing
    description: Billing management operations
  - name: Tickets
    description: Tickets management operations
  - name: Clients
    description: Clients management operations
  - name: Contacts
    description: Contacts management operations
  - name: Deletions
    description: Deletions management operations
  - name: Documents
    description: Documents management operations
  - name: Forms
    description: Forms management operations
  - name: Organization
    description: Organization management operations
  - name: Projects
    description: Projects management operations
paths:
  /v1/tickets:
    get:
      tags:
        - Tickets
      summary: Lists tickets
      description: >-
        Lists tickets for the service provider using cursor pagination. Default
        sort is `updatedOn desc`. sortBy accepts only `updatedOn` or
        `createdOn`; sortOrder accepts only `asc` or `desc` (case-insensitive) —
        any other value is rejected with a 400.
      operationId: get_v1_tickets
      parameters:
        - name: Cursor
          in: query
          description: >-
            Opaque pagination cursor from a previous page; omit for the first
            page.
          schema:
            type: string
        - name: PageSize
          in: query
          description: >-
            Number of items per page, 1-200 (default 50). Out of range is
            rejected, not clamped.
          schema:
            type: integer
            format: int32
            default: 50
        - name: SortBy
          in: query
          description: 'Sort field: `updatedOn` (default) or `createdOn`.'
          schema:
            type: string
            default: updatedOn
        - name: SortOrder
          in: query
          description: 'Sort direction: `asc` or `desc` (default).'
          schema:
            type: string
            default: desc
        - name: StatusIds
          in: query
          description: Comma-separated status ids to include. Omit for every status.
          schema:
            type: string
        - name: ClientIds
          in: query
          description: Comma-separated client ids to include. Omit for every client.
          schema:
            type: string
        - name: PriorityIds
          in: query
          description: >-
            Comma-separated priority ids on the public scale — None=0, Urgent=1,
            High=2, Normal=3, Low=4.
          schema:
            type: string
        - name: TypeIds
          in: query
          description: Comma-separated ticket type ids to include.
          schema:
            type: string
        - name: LeadAssigneeIds
          in: query
          description: Comma-separated lead assignee ids to include.
          schema:
            type: string
        - name: ContactIds
          in: query
          description: Comma-separated contact ids to include.
          schema:
            type: string
        - name: TagIds
          in: query
          description: Comma-separated tag ids; a ticket matches if it carries any of them.
          schema:
            type: string
        - name: GroupIds
          in: query
          description: >-
            Comma-separated group ids; a ticket matches if it is subscribed to
            any of them.
          schema:
            type: string
        - name: DeviceIds
          in: query
          description: >-
            Comma-separated agent ids (GUIDs, up to 100); a ticket matches if
            any of those agents is linked to it.
          schema:
            type: string
        - name: Query
          in: query
          description: >-
            Keyword matched against the ticket title, number and display number.
            Up to 200 characters.
          schema:
            type: string
        - name: UpdatedSince
          in: query
          description: ISO-8601 timestamp; keeps only tickets updated at or after it.
          schema:
            type: string
            format: date-time
        - name: UpdatedBefore
          in: query
          description: ISO-8601 timestamp; keeps only tickets updated strictly before it.
          schema:
            type: string
            format: date-time
        - name: CreatedSince
          in: query
          description: ISO-8601 timestamp; keeps only tickets created at or after it.
          schema:
            type: string
            format: date-time
        - name: CreatedBefore
          in: query
          description: ISO-8601 timestamp; keeps only tickets created strictly before it.
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/TicketListItemModelListBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TicketListItemModelListBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TicketListItemModelListBaseResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
components:
  schemas:
    TicketListItemModelListBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          type: array
          items:
            $ref: '#/components/schemas/TicketListItemModel'
          nullable: true
        DataContext:
          $ref: '#/components/schemas/PaginationDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ObjectBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          nullable: true
        DataContext:
          $ref: '#/components/schemas/ErrorDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    HttpStatusCode:
      enum:
        - 100
        - 101
        - 102
        - 103
        - 200
        - 201
        - 202
        - 203
        - 204
        - 205
        - 206
        - 207
        - 208
        - 226
        - 300
        - 301
        - 302
        - 303
        - 304
        - 305
        - 306
        - 307
        - 308
        - 400
        - 401
        - 402
        - 403
        - 404
        - 405
        - 406
        - 407
        - 408
        - 409
        - 410
        - 411
        - 412
        - 413
        - 414
        - 415
        - 416
        - 417
        - 421
        - 422
        - 423
        - 424
        - 426
        - 428
        - 429
        - 431
        - 451
        - 500
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 508
        - 510
        - 511
      type: integer
      format: int32
    TicketListItemModel:
      type: object
      properties:
        Id:
          type: string
          description: Ticket identifier.
          format: uuid
        Title:
          type: string
          description: Ticket title/subject.
        Number:
          type: integer
          description: Sequential ticket number.
          format: int64
          nullable: true
        DisplayNumber:
          type: string
          description: Human-readable ticket number, including any service-provider prefix.
        ClientId:
          type: integer
          description: Identifier of the client the ticket belongs to.
          format: int64
          nullable: true
        LocationId:
          type: integer
          description: Identifier of the client location the ticket belongs to.
          format: int64
          nullable: true
        ContactId:
          type: integer
          description: Identifier of the primary contact.
          format: int64
          nullable: true
        CcContactIds:
          type: array
          items:
            type: integer
            format: int64
          description: Identifiers of additional (CC) contacts.
        LeadAssigneeId:
          type: integer
          description: Identifier of the lead assignee (technician).
          format: int64
          nullable: true
        AssistingAssigneeIds:
          type: array
          items:
            type: integer
            format: int64
          description: Identifiers of assisting assignees (technicians).
        WatcherIds:
          type: array
          items:
            type: integer
            format: int64
          description: Identifiers of technicians watching the ticket.
        GroupIds:
          type: array
          items:
            type: integer
            format: int64
          description: Identifiers of all technician groups the ticket is assigned to.
        PrimaryGroupId:
          type: integer
          description: Identifier of the primary technician group.
          format: int64
          nullable: true
        Status:
          $ref: '#/components/schemas/CodeModel'
        StatusUpdatedOn:
          type: string
          description: Timestamp of the last status change (UTC).
          format: date-time
          nullable: true
        StatusReason:
          type: string
          description: Reason recorded for the current status, when applicable.
        Priority:
          $ref: '#/components/schemas/CodeModel'
        Source:
          $ref: '#/components/schemas/CodeModel'
        Type:
          $ref: '#/components/schemas/CodeModel'
        TagIds:
          type: array
          items:
            type: integer
            format: int64
          description: Identifiers of tags applied to the ticket.
        ChecklistSummary:
          $ref: '#/components/schemas/ChecklistSummaryModel'
        IsUnread:
          type: boolean
          description: Whether the ticket is currently unread.
        IsWaitingOnThem:
          type: boolean
          description: >-
            Whether the ticket is waiting on the client rather than on the
            service provider.
        IsMerged:
          type: boolean
          description: Whether the ticket has been merged into another ticket.
        MergedIntoTicketId:
          type: integer
          description: Identifier of the ticket this one was merged into, if any.
          format: int64
          nullable: true
        MergedTicketIds:
          type: array
          items:
            type: string
            format: uuid
          description: Identifiers of tickets merged into this one.
        Sla:
          $ref: '#/components/schemas/SlaModel'
        LastUpdate:
          $ref: '#/components/schemas/LastUpdateModel'
        CreatedOn:
          type: string
          description: Ticket creation timestamp (UTC).
          format: date-time
          nullable: true
        UpdatedOn:
          type: string
          description: >-
            Ticket last-updated timestamp (UTC). Default sort key for the list
            endpoint.
          format: date-time
          nullable: true
        ClosedOn:
          type: string
          description: Ticket closed timestamp (UTC), if closed.
          format: date-time
          nullable: true
      additionalProperties: false
      description: >-
        A ticket as returned by the ticket list endpoint. All timestamps are
        UTC.
    PaginationDataContext:
      type: object
      properties:
        Pagination:
          $ref: '#/components/schemas/PaginatedResponse'
      additionalProperties: false
      description: "The `DataContext` of a cursor-paginated success response: carries the paging metadata\r\nfor the returned page."
    Error:
      type: object
      properties:
        Code:
          pattern: ^[0-9]{6}$
          type: string
          description: 6-digit MMTTNN error code. See the Public API error-code registry.
          example: '070101'
        Message:
          type: string
        PropertyName:
          type: string
          nullable: true
        ActionHint:
          type: string
          nullable: true
        DocUrl:
          type: string
          nullable: true
      additionalProperties: false
    ErrorDataContext:
      type: object
      properties:
        TraceId:
          type: string
          description: Request correlation id. Quote this when reporting a problem.
          nullable: true
      additionalProperties: false
      description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest."
    CodeModel:
      type: object
      properties:
        Id:
          type: integer
          description: >-
            Numeric identifier of the coded value (e.g. status, priority, type,
            or source id).
          format: int64
          example: 1
        Name:
          type: string
          description: Display name of the coded value.
      additionalProperties: false
      description: >-
        A coded value, such as a status, priority, type or source, as an id and
        a display name.
    ChecklistSummaryModel:
      type: object
      properties:
        Completed:
          type: integer
          description: How many checklist items are completed.
          format: int32
        Total:
          type: integer
          description: How many checklist items exist in total.
          format: int32
      additionalProperties: false
      description: Checklist completion across every checklist on a ticket.
    SlaModel:
      type: object
      properties:
        FirstResponse:
          $ref: '#/components/schemas/SlaFirstResponseModel'
      additionalProperties: false
      description: SLA information for a ticket.
    LastUpdateModel:
      type: object
      properties:
        UpdateType:
          type: string
          description: "Type of the last update: New, CommentCreated, StatusUpdated, TechnicianMentioned,\r\nExternalCommentCreated, TechnicianUpdated, Read, Unread. Empty for any other update."
        Summary:
          type: string
          description: Short summary of the last update.
        'On':
          type: string
          description: Timestamp of the last update (UTC).
          format: date-time
          nullable: true
      additionalProperties: false
      description: Summary of the most recent update to a ticket.
    PaginatedResponse:
      type: object
      properties:
        NextCursor:
          type: string
          nullable: true
        PreviousCursor:
          type: string
          nullable: true
        HasMore:
          type: boolean
        HasPrevious:
          type: boolean
        TotalCount:
          type: integer
          format: int32
      additionalProperties: false
    SlaFirstResponseModel:
      type: object
      properties:
        ElapsedBusinessMinutes:
          type: number
          description: "Time from the ticket being created to its first response, in minutes.\r\n            Null until the ticket has had a first response."
          format: double
          nullable: true
      additionalProperties: false
      description: First-response SLA details.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Your Gorelo API key. See [Generate API key](/generate-api-key). If your
        data is hosted in Australia, click the base URL at the top of this page
        and select `https://api.aue.gorelo.io`.
      name: X-API-Key
      in: header

````

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