Qodex.ai

List all contracts

GET {{baseUrl}}/v1/contracts

To get a list of contracts

OAuth Scope

  • Desk.settings.READ

Request Params

KeyDatatypeRequiredDescription
fromstringFrom index
limitstringNumber of contracts to fetch
viewIdstringID of the view to apply while fetching the resources
departmentIdstringID of the department from which the contracts must be fetched
accountIdstringID of the account associated with the contract
ownerIdstringID of contract owner
sortBystringParameter that sorts contracts by one of these attributes:&nbsp;<br>accountName,<br>&nbsp;<br>contractName,<br>&nbsp;<br>contractEndDate,<br> <br>contractStartDate,<br>&nbsp;<br>createdTime, or<br>&nbsp;<br>modifiedTime.<br> The default order of sorting is ascending. To sort in descending order, prefix a - with the parameter.
includestringAllowed Value is: accounts

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;associatedSLAId&quot;:&quot;10000000149109&quot;,&quot;accountId&quot;:&quot;10000000265011&quot;,&quot;contractStatus&quot;:&quot;FUTURE&quot;,&quot;productId&quot;:null,&quot;endDate&quot;:&quot;2018-11-10&quot;,&quot;departmentId&quot;:&quot;10000000010762&quot;,&quot;contractName&quot;:&quot;C2&quot;,&quot;id&quot;:&quot;10000000270023&quot;,&quot;ownerId&quot;:&quot;10000000012902&quot;,&quot;startDate&quot;:&quot;2018-10-10&quot;},{&quot;associatedSLAId&quot;:&quot;10000000149109&quot;,&quot;accountId&quot;:&quot;10000000265011&quot;,&quot;contractStatus&quot;:&quot;EXPIRED&quot;,&quot;productId&quot;:null,&quot;endDate&quot;:&quot;2018-09-10&quot;,&quot;departmentId&quot;:&quot;10000000010762&quot;,&quot;contractName&quot;:&quot;New&quot;,&quot;id&quot;:&quot;10000000270045&quot;,&quot;ownerId&quot;:&quot;10000000012902&quot;,&quot;startDate&quot;:&quot;2018-09-09&quot;},{&quot;associatedSLAId&quot;:&quot;10000000149109&quot;,&quot;accountId&quot;:&quot;10000000272001&quot;,&quot;contractStatus&quot;:&quot;ACTIVE&quot;,&quot;productId&quot;:null,&quot;endDate&quot;:&quot;2018-12-11&quot;,&quot;departmentId&quot;:&quot;10000000010762&quot;,&quot;contractName&quot;:&quot;THIRD&quot;,&quot;id&quot;:&quot;10000000272013&quot;,&quot;ownerId&quot;:&quot;10000000012902&quot;,&quot;startDate&quot;:&quot;2018-09-11&quot;},{&quot;associatedSLAId&quot;:&quot;10000000149109&quot;,&quot;accountId&quot;:&quot;10000000272037&quot;,&quot;contractStatus&quot;:&quot;ACTIVE&quot;,&quot;productId&quot;:null,&quot;endDate&quot;:&quot;2019-03-11&quot;,&quot;departmentId&quot;:&quot;10000000010762&quot;,&quot;contractName&quot;:&quot;Fourth ACC&quot;,&quot;id&quot;:&quot;10000000272049&quot;,&quot;ownerId&quot;:&quot;10000000012902&quot;,&quot;startDate&quot;:&quot;2018-09-11&quot;},{&quot;associatedSLAId&quot;:&quot;10000000149109&quot;,&quot;accountId&quot;:&quot;10000000272071&quot;,&quot;contractStatus&quot;:&quot;EXPIRED&quot;,&quot;productId&quot;:null,&quot;endDate&quot;:&quot;2018-09-12&quot;,&quot;departmentId&quot;:&quot;10000000010762&quot;,&quot;contractName&quot;:&quot;old&quot;,&quot;id&quot;:&quot;10000000272083&quot;,&quot;ownerId&quot;:&quot;10000000012902&quot;,&quot;startDate&quot;:&quot;2017-09-11&quot;},{&quot;associatedSLAId&quot;:&quot;10000000149109&quot;,&quot;accountId&quot;:&quot;10000000265011&quot;,&quot;contractStatus&quot;:&quot;ACTIVE&quot;,&quot;productId&quot;:null,&quot;endDate&quot;:&quot;2018-09-30&quot;,&quot;departmentId&quot;:&quot;10000000010762&quot;,&quot;contractName&quot;:&quot;FUTURE 1&quot;,&quot;id&quot;:&quot;10000000273003&quot;,&quot;ownerId&quot;:&quot;10000000012902&quot;,&quot;startDate&quot;:&quot;2018-09-15&quot;},{&quot;associatedSLAId&quot;:&quot;10000000149109&quot;,&quot;accountId&quot;:&quot;10000000265011&quot;,&quot;contractStatus&quot;:&quot;FUTURE&quot;,&quot;productId&quot;:null,&quot;endDate&quot;:&quot;2018-12-11&quot;,&quot;departmentId&quot;:&quot;10000000010762&quot;,&quot;contractName&quot;:&quot;FUTURE 3&quot;,&quot;id&quot;:&quot;10000000273025&quot;,&quot;ownerId&quot;:&quot;10000000012902&quot;,&quot;startDate&quot;:&quot;2018-11-11&quot;}]}