GET api/Tickets/GetTickets?pageIndex={pageIndex}&pageSize={pageSize}

Gets a list of all Tickets visible to the user. Pagination is supported.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageIndex

Optional page index (default is 0).

integer

None.

pageSize

Optional page size (default is 200).

integer

None.

Body Parameters

None.

Response Information

Resource Description

GetTicketsResult
NameDescriptionTypeAdditional information
PagedTickets

A page with Ticket rows.

TicketRow

None.

Response Formats

application/json, text/json

Sample:
{
  "PagedTickets": {
    "PageIndex": 0,
    "PageSize": 200,
    "TotalItems": 1028,
    "TotalPages": 6,
    "Items": [
      {
        "TicketId": 168,
        "TicketType": 1,
        "TicketREF": "TIC-000168",
        "Subject": "Toner for printer is needed",
        "CreatedUTC": "2024-04-27T01:02:18.0013395Z",
        "Unread": true,
        "Closed": false,
        "ClosedUTC": null,
        "SubmitterKey": "9e2dceae-42c8-4c60-817d-3676f38b95ad",
        "SubmitterFullName": "John Doe",
        "SubmitterCompany": null,
        "SolverKey": null,
        "SolverFullName": null,
        "TicketState": 101,
        "TicketSummaryState": 1,
        "Source": 1,
        "TicketUserSourceId": 0,
        "ServiceId": 2,
        "ServiceName": "Supply material",
        "MarkedAsSolvedUTC": null,
        "DeadlineUTC": null,
        "UserMessagesCount": 2,
        "AttachmentsCount": 0,
        "FirstMessage": null,
        "Priorities": null,
        "CustomForms": null,
        "Tags": [
          {
            "Id": 1,
            "Name": "Sample tag",
            "Static": true,
            "Color": "#ffffff",
            "Type": 1
          },
          {
            "Id": 2,
            "Name": "Sample 2",
            "Static": true,
            "Color": "#fafafa",
            "Type": 1
          }
        ],
        "VotesCount": 0,
        "StickyNotesCount": 0,
        "SelectedCategories": null,
        "LastActivityDateUTC": "2024-04-27T01:52:18.0013395Z",
        "CustomerId": null,
        "Invitations": null,
        "Satisfactions": null,
        "TicketRelations": null,
        "ProductItems": null,
        "ServiceMailboxId": null
      },
      {
        "TicketId": 143,
        "TicketType": 2,
        "TicketREF": "INC-000047",
        "Subject": "My Mac is very slow",
        "CreatedUTC": "2024-04-26T09:02:18.0013395Z",
        "Unread": false,
        "Closed": false,
        "ClosedUTC": null,
        "SubmitterKey": "5b846c5f-5c6f-4a45-b44b-528ffa36d63e",
        "SubmitterFullName": "Jane Doe",
        "SubmitterCompany": null,
        "SolverKey": "58dd47ff-ed20-4667-a632-e630448f672e",
        "SolverFullName": "Handyman",
        "TicketState": 205,
        "TicketSummaryState": 6,
        "Source": 2,
        "TicketUserSourceId": 0,
        "ServiceId": 1,
        "ServiceName": "IT support",
        "MarkedAsSolvedUTC": null,
        "DeadlineUTC": null,
        "UserMessagesCount": 2,
        "AttachmentsCount": 1,
        "FirstMessage": null,
        "Priorities": null,
        "CustomForms": null,
        "Tags": null,
        "VotesCount": 0,
        "StickyNotesCount": 0,
        "SelectedCategories": null,
        "LastActivityDateUTC": "2024-04-26T10:32:18.0013395Z",
        "CustomerId": null,
        "Invitations": null,
        "Satisfactions": [
          {
            "SatisfactionId": 1,
            "CompletedUtc": "2024-04-26T10:32:18.0013395Z",
            "EmailWasSent": true,
            "IsCompleted": false,
            "Text": null,
            "UserProviderKey": null,
            "Value": 1.0
          }
        ],
        "TicketRelations": null,
        "ProductItems": null,
        "ServiceMailboxId": null
      }
    ]
  }
}

application/xml, text/xml

Sample:
<GetTicketsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <PagedTickets>
    <Items>
      <GetTicketsResult.TicketRow>
        <AttachmentsCount>0</AttachmentsCount>
        <Closed>false</Closed>
        <ClosedUTC i:nil="true" />
        <CreatedUTC>2024-04-27T01:02:18.0013395Z</CreatedUTC>
        <CustomForms i:nil="true" />
        <CustomerId i:nil="true" />
        <DeadlineUTC i:nil="true" />
        <FirstMessage i:nil="true" />
        <Invitations xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <LastActivityDateUTC>2024-04-27T01:52:18.0013395Z</LastActivityDateUTC>
        <MarkedAsSolvedUTC i:nil="true" />
        <Priorities i:nil="true" />
        <ProductItems xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <Satisfactions xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <SelectedCategories xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <ServiceId>2</ServiceId>
        <ServiceMailboxId i:nil="true" />
        <ServiceName>Supply material</ServiceName>
        <SolverFullName i:nil="true" />
        <SolverKey i:nil="true" />
        <Source>Web</Source>
        <StickyNotesCount>0</StickyNotesCount>
        <Subject>Toner for printer is needed</Subject>
        <SubmitterCompany i:nil="true" />
        <SubmitterFullName>John Doe</SubmitterFullName>
        <SubmitterKey>9e2dceae-42c8-4c60-817d-3676f38b95ad</SubmitterKey>
        <Tags xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
          <d5p1:TagData>
            <d5p1:Color>#ffffff</d5p1:Color>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Name>Sample tag</d5p1:Name>
            <d5p1:Static>true</d5p1:Static>
            <d5p1:Type>Ticket</d5p1:Type>
          </d5p1:TagData>
          <d5p1:TagData>
            <d5p1:Color>#fafafa</d5p1:Color>
            <d5p1:Id>2</d5p1:Id>
            <d5p1:Name>Sample 2</d5p1:Name>
            <d5p1:Static>true</d5p1:Static>
            <d5p1:Type>Ticket</d5p1:Type>
          </d5p1:TagData>
        </Tags>
        <TicketId>168</TicketId>
        <TicketREF>TIC-000168</TicketREF>
        <TicketRelations xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <TicketState>TicketInQueue</TicketState>
        <TicketSummaryState>Registered</TicketSummaryState>
        <TicketType>EndUserTicket</TicketType>
        <TicketUserSourceId>0</TicketUserSourceId>
        <Unread>true</Unread>
        <UserMessagesCount>2</UserMessagesCount>
        <VotesCount>0</VotesCount>
      </GetTicketsResult.TicketRow>
      <GetTicketsResult.TicketRow>
        <AttachmentsCount>1</AttachmentsCount>
        <Closed>false</Closed>
        <ClosedUTC i:nil="true" />
        <CreatedUTC>2024-04-26T09:02:18.0013395Z</CreatedUTC>
        <CustomForms i:nil="true" />
        <CustomerId i:nil="true" />
        <DeadlineUTC i:nil="true" />
        <FirstMessage i:nil="true" />
        <Invitations xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <LastActivityDateUTC>2024-04-26T10:32:18.0013395Z</LastActivityDateUTC>
        <MarkedAsSolvedUTC i:nil="true" />
        <Priorities i:nil="true" />
        <ProductItems xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <Satisfactions xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
          <d5p1:SatisfactionData>
            <d5p1:CompletedUtc>2024-04-26T10:32:18.0013395Z</d5p1:CompletedUtc>
            <d5p1:EmailWasSent>true</d5p1:EmailWasSent>
            <d5p1:IsCompleted>false</d5p1:IsCompleted>
            <d5p1:SatisfactionId>1</d5p1:SatisfactionId>
            <d5p1:Text i:nil="true" />
            <d5p1:UserProviderKey i:nil="true" />
            <d5p1:Value>1</d5p1:Value>
          </d5p1:SatisfactionData>
        </Satisfactions>
        <SelectedCategories xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <ServiceId>1</ServiceId>
        <ServiceMailboxId i:nil="true" />
        <ServiceName>IT support</ServiceName>
        <SolverFullName>Handyman</SolverFullName>
        <SolverKey>58dd47ff-ed20-4667-a632-e630448f672e</SolverKey>
        <Source>Email</Source>
        <StickyNotesCount>0</StickyNotesCount>
        <Subject>My Mac is very slow</Subject>
        <SubmitterCompany i:nil="true" />
        <SubmitterFullName>Jane Doe</SubmitterFullName>
        <SubmitterKey>5b846c5f-5c6f-4a45-b44b-528ffa36d63e</SubmitterKey>
        <Tags xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <TicketId>143</TicketId>
        <TicketREF>INC-000047</TicketREF>
        <TicketRelations xmlns:d5p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
        <TicketState>IncidentAnalyzed</TicketState>
        <TicketSummaryState>SolutionApproved</TicketSummaryState>
        <TicketType>Incident</TicketType>
        <TicketUserSourceId>0</TicketUserSourceId>
        <Unread>false</Unread>
        <UserMessagesCount>2</UserMessagesCount>
        <VotesCount>0</VotesCount>
      </GetTicketsResult.TicketRow>
    </Items>
    <PageIndex>0</PageIndex>
    <PageSize>200</PageSize>
    <TotalItems>1028</TotalItems>
    <TotalPages>6</TotalPages>
  </PagedTickets>
</GetTicketsResult>