v1

latestOpenAPI 3.0.32026-08-068925782.3 MB
Contracts

get/contracts

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

agreement.idstring

Filter for: agreement.id

lookups: eq, ne, like, ilike, null, in, out

search: true

agreement.namestring

Filter for: agreement.name

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

agreement.owner.idstring

Filter for: agreement.owner.id

lookups: eq, ne, like, ilike, null, in, out

agreement.product_groups.idstring

Filter for: agreement.product_groups.id

lookups: eq, ne, like, ilike, null, in, out

agreement.product_groups.products.idstring

Filter for: agreement.product_groups.products.id

lookups: eq, ne, like, ilike, null, in, out

agreement.sourcing_agreement.idstring

Filter for: agreement.sourcing_agreement.id

lookups: eq, ne, like, ilike, null, in, out

agreement.sourcing_agreement.type'distribution' | 'program' | 'service' | 'syndication' | 'referral'

Filter for: agreement.sourcing_agreement.type

lookups: eq, ne, like, ilike, in, out

agreement__idstring

Filter for: agreement__id

lookups: eq, ne, like, ilike, null, in, out

agreement__namestring

Filter for: agreement__name

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

agreement__owner__idstring

Filter for: agreement__owner__id

lookups: eq, ne, like, ilike, null, in, out

events.created.atstring date-time

Filter for: events.created.at

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

events.created.by.idstring

Filter for: events.created.by.id

lookups: eq, ne, like, ilike, null, in, out

events.created.by.namestring

Filter for: events.created.by.name

lookups: eq, ne, like, ilike, null, in, out

search: true

events.signed.by.idstring

Filter for: events.signed.by.id

lookups: eq, ne, like, ilike, null, in, out

events.signed.by.namestring

Filter for: events.signed.by.name

lookups: eq, ne, like, ilike, in, out

search: true

idstring

Filter for: id

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

issuer.idstring

Filter for: issuer.id

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

issuer.namestring

Filter for: issuer.name

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

kind'production' | 'test'

Filter for: kind

lookups: eq, ne, like, ilike, in, out

marketplace.idstring

Filter for: marketplace.id

lookups: eq, ne, like, ilike, null, in, out

search: true

marketplace.namestring

Filter for: marketplace.name

lookups: eq, ne, like, ilike, in, out

search: true

marketplace__idstring

Filter for: marketplace__id

lookups: eq, ne, like, ilike, null, in, out

marketplace__namestring

Filter for: marketplace__name

lookups: eq, ne, like, ilike, in, out

search: true

owner.idstring

Filter for: owner.id

lookups: eq, ne, like, ilike, null, in, out

owner.namestring

Filter for: owner.name

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

owner__idstring

Filter for: owner__id

lookups: eq, ne, like, ilike, null, in, out

owner__namestring

Filter for: owner__name

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

partner.idstring

Filter for: partner.id

lookups: eq, ne, like, ilike, null, in, out

referral.agreement.idstring

Filter for: referral.agreement.id

lookups: eq, ne, like, ilike, null, in, out

sourcing.listing.idstring

Filter for: sourcing.listing.id

lookups: eq, ne, like, ilike, null, in, out

sourcing.marketplace.idstring

Filter for: sourcing.marketplace.id

lookups: eq, ne, like, ilike, null, in, out

sourcing.marketplace.namestring

Filter for: sourcing.marketplace.name

lookups: eq, ne, like, ilike, in, out

sourcing.product.idstring

Filter for: sourcing.product.id

lookups: eq, ne, like, ilike, null, in, out

sourcing.product.namestring

Filter for: sourcing.product.name

lookups: eq, ne, like, ilike, in, out

status'new' | 'enrolling' | 'pending' | 'active' | 'terminated' | 'rejected'

Filter for: status

lookups: eq, ne, like, ilike, in, out

ordering: true

type'distribution' | 'program' | 'service' | 'syndication' | 'referral'

Filter for: type

lookups: eq, ne, like, ilike, in, out

Response

idstring
typestring
versioninteger nullable
statusstring
version_createdstring date-time nullable
namestring
enrolledstring date-time nullable
lateststring
kind'production' | 'test'
expire_atstring date-time nullable
notestring nullable
permissionsobject nullable
termination_notestring nullable