Skip to main content
GET
List contracts

Authorizations

Authorization
string
header
required

OAuth 2.0. Obtain an access token via the Client Credentials or Authorization Code flow, then send it as Authorization: Bearer <token>.

Query Parameters

filter
string

A SCIM-style filter expression restricting the items returned. See the Filtering section of the introduction for the operators and syntax; the filterable fields are listed per resource.

Filterable fields

  • string: createdBy.email, createdBy.name, createdBy.userId, documents[description], documents[id], documents[linkUrl], externalId, id, lastModifiedBy.email, lastModifiedBy.name, lastModifiedBy.userId, lineItems[currency], lineItems[description], lineItems[externalId], lineItems[id], lineItems[notes], notes, paymentMethod, type, vendorName
  • number: lineItems[amount], lineItems[unitCount], terminationNoticeDays
  • date: agreementDate, createdDtm, lastModifiedDtm, lineItems[endDate], lineItems[startDate], renewalDate, startDate
  • boolean: deleted, isAutomaticRenewal

Filter examples

  • vendorName eq "Agilebits Inc" — Contracts whose vendor is "Agilebits Inc"
  • vendorName sw "Micros" — Contracts with vendors starting with "Micros", e.g. "Microsoft"
  • lineItems[unitCount gt 100] — Contracts with a line item of more than 100 units
  • isAutomaticRenewal eq true — Contracts that automatically renew
  • agreementDate ge "2021-06-01" — Contracts with agreement dates on or after 1 Jun 2021
q
string

Free-text search across the resource's displayable fields.

since
string<date-time>

Only return items modified at or after this ISO-8601 timestamp.

until
string<date-time>

Only return items modified at or before this ISO-8601 timestamp.

after
string

Opaque pagination cursor supplied by SaaS Manager via the link response header and the next field.

limit
integer
default:100

Maximum number of items to return per page (default 100, maximum 1000).

Required range: 1 <= x <= 1000

Response

OK

next
string

The URL of the next page of results. Absent when there are no more results.

results
object[]

The page of results.