Sign in

v1

latestOpenAPI 3.1.02026-07-2489171167.4 KB
License Manager Public

Get a List of Contracts

Retrieve a paginated list of contracts in your SysAid account.

get/license-manager/contracts

Query parameters

offsetinteger

The offset for pagination. Calculated as (page - 1) * limit (page starts at 1).

limitinteger

The number of records to return per page, up to 500.

querystring

Query to search entities.

sortBy'name' | 'status' | 'type' | 'category' | 'startDate' | 'endDate' | 'paymentTerm' | 'contractValue' | 'currency' | 'licensesCount' | 'autoRenewal' | 'cancellationNotice' | 'cancellationDeadline' | 'notes' | 'dateCreated' | 'dateUpdated'

The field by which results are sorted. The default is "dateCreated".

sortDir'asc' | 'desc'

The direction in which results are sorted. The default is "desc" (descending).

statusstring[]

Filter results by one or more contract statuses.

typestring[]

Filter results by one or more contract types.

categorystring[]

Filter results by one or more contract categories.

startDateFromstring date

The earliest start date to include in the results (inclusive).

startDateTostring date

The latest start date to include in the results (inclusive).

endDateFromstring date

The earliest end date to include in the results (inclusive).

endDateTostring date

The latest end date to include in the results (inclusive).

contractValueFromnumber

The minimum contract value to include in the results (inclusive).

contractValueTonumber

The maximum contract value to include in the results (inclusive).

licensesCountFrominteger

The minimum number of licenses to include in the results (inclusive).

licensesCountTointeger

The maximum number of licenses to include in the results (inclusive).

Response

Contract list.

limitinteger

The number of items that are returned per page

offsetinteger

The offset used for pagination.

totalinteger

The total number of elements across all pages.

Example response

{
  "limit": 20,
  "total": 50,
  "data": [
    {
      "name": "Slack Enterprise Annual",
      "applicationId": "cm9z8y7x6w5v4u3t2s1r0q9p",
      "status": "active",
      "type": "saas",
      "category": "developer-tools",
      "startDate": "2025-01-01",
      "endDate": "2026-01-01",
      "paymentTerm": "annual",
      "contractValue": 12000,
      "currency": "USD",
      "licensesCount": 50,
      "autoRenewal": true,
      "cancellationNotice": 30,
      "notes": "Renewed with 10% discount",
      "id": "cm1a2b3c4d5e6f7g8h9i0j1k",
      "application": {
        "category": "developer-tools",
        "currency": "USD",
        "dateCreated": "2025-06-15T10:30:00Z",
        "dateUpdated": "2025-08-20T14:30:00Z"
      },
      "cancellationDeadline": "2025-12-02T23:59:59.000Z",
      "dateCreated": "2025-01-15T10:30:00.000Z",
      "dateUpdated": "2025-06-20T14:45:00.000Z"
    }
  ]
}