GET api/Contract?pageNumber={pageNumber}&pageSize={pageSize}

Retrieves all of your contracts with pagination.

Request Information

Parameters

NameDescriptionAdditional information
pageNumber 
The page number to get

Define this parameter in the request URI.
pageSize 
The page size to get

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample: 
{
  "is_last": true,
  "contract_info": [
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Number": "sample string 3",
      "EndDateTime": "2025-11-03T21:07:50.1797884-05:00",
      "StartDateTime": "2025-11-03T21:07:50.1797884-05:00",
      "Agents": [
        1,
        2,
        3
      ],
      "ProviderId": 6,
      "CustomerId": 7,
      "id": 1
    },
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Number": "sample string 3",
      "EndDateTime": "2025-11-03T21:07:50.1797884-05:00",
      "StartDateTime": "2025-11-03T21:07:50.1797884-05:00",
      "Agents": [
        1,
        2,
        3
      ],
      "ProviderId": 6,
      "CustomerId": 7,
      "id": 1
    },
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Number": "sample string 3",
      "EndDateTime": "2025-11-03T21:07:50.1797884-05:00",
      "StartDateTime": "2025-11-03T21:07:50.1797884-05:00",
      "Agents": [
        1,
        2,
        3
      ],
      "ProviderId": 6,
      "CustomerId": 7,
      "id": 1
    }
  ]
}

application/xml, text/xml

Sample: 
<contracts_page xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api.Org">
  <contract_info>
    <contracts_page_item>
      <id xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api">1</id>
      <Agents xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
        <d4p1:long>3</d4p1:long>
      </Agents>
      <CustomerId>7</CustomerId>
      <Description>sample string 2</Description>
      <EndDateTime>2025-11-03T21:07:50.1797884-05:00</EndDateTime>
      <Name>sample string 1</Name>
      <Number>sample string 3</Number>
      <ProviderId>6</ProviderId>
      <StartDateTime>2025-11-03T21:07:50.1797884-05:00</StartDateTime>
    </contracts_page_item>
    <contracts_page_item>
      <id xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api">1</id>
      <Agents xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
        <d4p1:long>3</d4p1:long>
      </Agents>
      <CustomerId>7</CustomerId>
      <Description>sample string 2</Description>
      <EndDateTime>2025-11-03T21:07:50.1797884-05:00</EndDateTime>
      <Name>sample string 1</Name>
      <Number>sample string 3</Number>
      <ProviderId>6</ProviderId>
      <StartDateTime>2025-11-03T21:07:50.1797884-05:00</StartDateTime>
    </contracts_page_item>
    <contracts_page_item>
      <id xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api">1</id>
      <Agents xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
        <d4p1:long>3</d4p1:long>
      </Agents>
      <CustomerId>7</CustomerId>
      <Description>sample string 2</Description>
      <EndDateTime>2025-11-03T21:07:50.1797884-05:00</EndDateTime>
      <Name>sample string 1</Name>
      <Number>sample string 3</Number>
      <ProviderId>6</ProviderId>
      <StartDateTime>2025-11-03T21:07:50.1797884-05:00</StartDateTime>
    </contracts_page_item>
  </contract_info>
  <is_last>true</is_last>
</contracts_page>